User Forums/Official SAManage/Integration & API

Getting started with the SAManage API

Old Engineering
posted this on September 19, 2010 11:46

The SAManage REST API allows customers and developers to expand and build on the SAManage platform.

Introduction

SAManage provides an API that can be used to retrieve and update asset inventory information from your SAManage account. The SAManage API also allows to create, retrieve, update and delete asset information such as computers, software, printers, risks and other assets, contracts and software licenses, and help desk tickets. The API makes it easy to create applications and interface between your business systems and your SAManage account. 

Some potential application ideas:

  1. Integrate internal help desk / call center system to view asset information
  2. Automatic contract / license creation from your procurement system
  3. Trigger business processes based on tickets, for example new asset purchase request
  4. Automate asset maintenance and disposal processes
  5. Notify internal stakeholders of new risks and license compliance gaps

The SAManage API is built upon REST principles, making access to these actions consistent and intuitive. Collections are accessed via a URL ending in a plural noun such as '/hardwares', and to target an individual record, append it's numerical id (/hardwares/205778). To tell the API whether you are retrieving, updating, or deleting the record, make use of the "HTTP verbs", GET, PUT, and DELETE (respectively). For example, to create a new record, send a POST request to the collection's URL (/hardwares). The API will respond with a document reflecting your changes.

Tip: When building your API requests, as a best practice we recommend logging into your online SAManage account and reviewing your inventory and asset information. You can than compare the response your API calls receive with the information as shown in the online account.

We recommend using curl for developing and testing out the various features that the API offers. Another online option to curl is hurl.