To access and interact with the Aurora API, you’ll first need to generate a project-specific API key to authenticate API requests. This article walks you through the process from start to finish.
Step 1: Create a Service Account and Generate an API Key
-
Log in to your organization.
-
Navigate to Organization Settings → API.
-
Click on Create new service account. A small window will pop up, asking Name and the Project under which the service account should be created. After filling it up, click Create.
-
By default, the an initial API key is generated. Make sure to copy and store it securely, as you won’t be able to view it again later.
-
You can create multiple keys per service account. If you want to generate another key under the same service account, you can revoke the access to the previous one, and create a new key by giving it a name and clicking Generate new key at the top.
-
You can also manage which projects this service account has access to by clicking on Manage access and selecting all the projects you want access for. Note that you can only select the projects you are part of.
IMPORTANT: Keep your API keys secure. Do not share them publicly.
Step 2: Test Your API Key
-
Open the Aurora API Documentation Portal.
-
Select an endpoint to test—for example, List all bandsets. Click on Try it to test. out the API Key.
-
In the Authentication field, paste your API key. and click Send to send your request
- If you receive a response with code 200, it means that your request went through and your API key is working just fine. If you receive response code 40x, check your request parameters for some errors.
That’s It!
You’ve successfully generated and tested your API key. You’re now ready to build with the Aurora API!
Need help with specific endpoints or error handling? Visit the full API reference for more details.
0 comments
Please sign in to leave a comment.