Using the API

You can set up a Linux command to quickly retrieve an access token. Use the Swagger UI to test (yielding a truncated number of records) or use the Swagger UI cURL commands to run all the records.

Getting an access token via Linux commands

When you activated the API Application Programming Interface (API) is the developer interface for the platform. Use the API to develop your own applications., the Linux commands to get an access token are listed under Command Line Authentication.

 

Replace the capitalized CLIENT_ID and CLIENT_SECRET with your own values. The access_token displays on execution.

You can then the access token into the user interface, like you did during activation. For example, US customers access the user interface via https://api.securimate.com/. (Client IDs and client secrets do not expire.)

Swagger

Swagger documents the endpoints available. Use the Swagger UI to learn how the cURL statements should be formed for each command. To learn more about the Swagger UI, see the Swagger UI.

Swagger display examples

Click an endpoint in Swagger to display information about the endpoint. This information is provided:

• What the endpoint is for
• An Example Value
• "Try it out!" feature (See Swagger Try it out! information.)

Swagger Try it out! information

When you select Try it out!, you see the following information. (Responses are truncated to a few records.)

• The cURL statement used. Paste the cURL statement to a bash shell to generate output without Swagger truncating the number of records. To avoid truncation, you must remove the header from the space to the single quote. For example, from GET countries/sparse, remove:
  --header 'X-Ident; swagger-ui'
  
• The request URL
• An example of the return value output from the environment (Response Body, Response Code, and Response Headers)