Authentication

To interact with the Autonoma API, a personal access token is required. This token is associated with a user scope and is issued for a specific user role. When making requests with this token, you have access to the same assets, metadata, data streams, etc., that you can see in the browser.

Creating an Access Token

1. Navigate to your personal profile by clicking on your name in the upper right corner and selecting “Your Account.”

2. Go to the “API Access Tokens” tab and click on “Create Access Token.”

3. Configure the following options:

• Name: Assign a name to your access token for future identification.
• Expiration: Set the duration for which this token can be used. Use “never” only if this token is used in secure environments.
• Scope: Define the role this access token will use. Only assets viewable by this role can be interacted with using this token.

4. Click on “Create Token” to generate the token.

Important: The key will only be displayed once! Ensure you store the key in a secure password manager or similar tool.

Using the Access Token

To authenticate with this token, set a special header in your requests. Include the header x-api-token (case-insensitive) in your API requests.

For example, when using Postman, define the x-api-token header with your token value to authenticate your requests.

By following these steps, you can securely interact with the Autonoma API using personal access tokens.

What's next

To actually use the API explore the available resources. The most used ones are: