Skip to main content

Introduction to the Astrocast API

Learn how to retrieve your data in your backend system

1. Create an access token

  1. Go to the Astrocast Portal.
  2. In the bottom left corner, click on ⚙️ Settings.
  3. Click on Access Tokens.
  4. Click on ➕ create new access token.
  5. Enter the access token's Name, set an Expiration date and assign a Role.
  6. Click on Create.
  7. 🗒️ Copy the access token and store it in a safe place.

You are responsible of storing your access token in a secure location. Astrocast cannot retrieve an access token if you lose one.

2. Try the API

  1. Go on the Astrocast API Reference.
  2. In the sidebar, click on "Get devices".
  3. Click on Try it ▶️ button.
  4. Remove all the default parameters by clicking on the 🗑️ icon.
  5. Fill-in the X-Api-Key header with the access token generated above.
  6. Click on Send.
  7. You shoud receive a 200 response code and the list of your devices in a JSON body.