API Configuration

Asset Panda’s API is completely open and free to be leveraged in a multitude of ways. It supports popular and other commonly used languages.

 

Only company administrators are able to access the API tool. There is a 400 calls per three minute window limitation per IP Address. 

 

API credentials and login

You must first obtain credentials to access the API tool but don't worry; we won't make you jump through hoops to get them. We keep it pretty simple.

 

To access the API tool:

 

1. Click your settings  icon, and then select API Configuration.

 

 

2. Provide your answers to our questions on the API Configuration page. 

 

 

3. Click Update, and your API credentials (Client ID and Client Secret) are displayed at the bottom of the page.

 

You won't have to do this every time you navigate to this page. The questions will remain on the page, but your credentials will continue to be displayed at the bottom of the page from this point forward. 

 

4. Click the link provided within the Login instructions to log into the API tool. 

5. Click the API documentation page link if you need assistance with using the API tool. 

The documentation will allow you to view sample requests/responses, and to try your own.

 

API terminology and types of API calls

The following provides API terminology and types of calls for Version 2 (V2) of our API. Click here to access Version 3 (V3). 

 

Note: Since Asset Panda’s API is completely open, extensive support isn’t available to this section of the system. Asset Panda doesn’t provide services to create calls or debug scripts.

 

This specific article provides you with basic terminology and types of calls to give you a better idea of the calls you can make.

 

Terminology

Entity or Entities: The names of your groups (Assets, Categories, Buildings, Rooms, etc)

Entity_ID: A group’s identifying number

  • Go to: Configuration > Group Settings > Click Edit link next to group name > It is the numeric value near the end of the webpage URL
  • Example: “ /12345/edit “

Entity Objects: The fields inside the Groups (Name, Description, Purchase Date, Cost, etc)

Entity Object ID: An asset’s identifying number

  • Go to: Groups > Assets > Select ‘View’ link next to an asset > It is the long, numeric value near the end of the webpage URL
  • Example: “ /5a6668c969702d1211680400/edit “

Field_9, field_12: The identifying number of the fields on the asset record

  • Go to: Groups > Assets > Select ‘View’ link next to an asset > Click inside of a field > Right-click > Inspect
  • Look for: id=”values_field_9”

Offset: pull the results past the numeric value of 50

  • Enter in 70 = will pull results 70-120

Field_filters: advanced search

  • If they do a search and it pulls back results for everything, ask them if they closed the brackets:
  • {“field_6":{search 6]}

$term= : a search term