API credential creation

Prior to using API endpoints you have to create an API access and retrieve its credentials.

Step-by-step guide

  1. Go to the Group tab.
  2. Navigate to your group and click on its name.
  3. In the left panel menu click on API access.
  4. In the upper right corner click on New.
  5. Specify a name for your API access. This is an informative field that might, for instance, help you identify the applications using the credentials
  6. Choose a timezone:
    • API endpoints may return Epoch or human readable time. Please be aware that this timezone setting only affects human readable format time

      Example: "Error status events sent for a list of devices" endpoint

      No message is received since 3PM GMT and your time zone is set to Japan, the API will return a human readable time set to 7AM.

  7. Grant at least one profile to your API access:

    • Upon API access creation you will have to grant it rights. In a sense one could consider an API access rights as a user.

      User roles are described in the following article: Backend user roles

Can't find what you're looking for ?

Have questions? Our worldwide Community of expert fans can answer them.
Have answers? Join the Community and help!

slack logo

Ask the community >