Asset Manager API Overview

API Overview

An application programming interface (API) is a set of rules, protocols, and tools that allows different software applications to communicate and interact. APIs define the methods and data formats used for communication between software components, enabling them to exchange information and perform specific tasks.

APIs are comprised of numerous endpoint calls. An endpoint is a specific element within SIP, such as a domain ID; a call is a set task performed on the endpoint. API calls can add, modify, delete, or simply retrieve user data in a software application. The list below defines API endpoint call headers.

  • GET - retrieves specified information on specific element
  • PUT - updates a specified element
  • POST - send data to an API, either creating or updating an element
  • DELETE - deletes specified element

"Element" is a general term used to refer to a specific component, feature, or entity within an API. It represents a distinct part or aspect of the API that provides a particular functionality or serves a specific purpose.

How API calls can be used for Asset Manager

The Asset Manager Swagger API calls are dynamically generated.

API calls can be executed in several different ways:

  • Using the browser*
  • Using cURL
  • Using Postman

Each task you can execute in Asset Manager has a corresponding API endpoint to match it. 

Accessing API endpoints through an API client such as Postman, a developer can use the API to integrate Asset Manager into existing software platforms and customize Asset Manager functionality. For example, you could use the API to build a tool to create custom reports.

The preferred method is using the browser -- accessing the Swagger UI from within the Asset Manager Help menu.