REST API Authentication

Have more questions? Submit a request

To use REST API, you need Device Plan 1.0, 2.0 or 3.0. REST API does not work on free Open Device Plan.

For REST API your application needs to be authenticated using request Header: X-Auth.

You can create your private token to access the selected Organization.

How to generate X-Auth token

  1. Go to Organizations section in signageOS Box
  2. Select Organization you need the token for
  3. Select API Token tab
  4. Fill in name for your Token and press Add new token
  5. Once generated, save the Token ID and Token Secret.

Token Secret is only available at a time of creating a token. It's not visible once you close the modal window.

generate-token.gif

Use X-Auth token

Use generated token as X-Auth header separated by colon. E.g __TOKEN_ID__:__TOKEN_SECRET__

# X-Auth = token_id:token_secret
curl -XGET --header 'x-auth: c19ae9e88d89ac705295:46595b112172e013efae6ffa73015f3d0e43f1d9'
  https://api.signageos.io/v1/device

Keep in mind that after you reload the page the token will disappear.

Was this article helpful?
0 out of 0 found this helpful
Share