General Rules

  • The REST API is available below the base URL:

/public/external/api

  • All requests have to be send via POST.
  • The REST API only supports requests via HTTPS.
  • Requests must contain the following Headers:
Edit

Header Name



Header Value



Description



Content-type



application/json



fixed



auth



123…xyz



API Key from the “API Access” Tab



signature



Base64 encoded signature



Signature of the payload generated with the


private Key from the “API Access” Tab


  • The request body must be a json encoded object which must contain the following values:
Edit

Field



Field Example Value



Description



api



v2/device/listdevices



Name of the API



time



1529662725



Unix Timestamp (UTC) of the client machine.


The maximum allowed time difference


between the client and the server is 30


minutes.


  • On success the API returns the requested data (see the Queries below) and an HTTP status code 200.
  • If an error occurs, the HTTP status code will be between 4xx and 5xx depending on error and the response object will contain an array with the key “errors”, which contains a list of human readable error messages.
  • If there is no matching data for a device an empty array will be returned.
  • If a device Id does not exist it’s return data will be null.
This site is registered on wpml.org as a development site. Switch to a production site key to remove this banner.