API
How to use the Amini API endpoints
Introduction
Leverage the external API to programmatically trigger an update when desired. The primary use-case will be pull datapoints from the Amini Data Catalog. We will be adding more and more functionality to the API overtime. Let us know what else you want to see in our community!
Authentication
You can generate an API key through the dashboard. The API key is associated with the entire org and can be used across multiple deployments.
Step 1: Go to the Amini Lite API Key page to generate your API key.
Step 2: Generate an API Key.
Step 3: This gives you an API Key that you need to note of and copy somewhere safe. Copy the API Key you just generated.
Your API keys are powerful tools, so protect them carefully.
To use the API, you must include a valid API key with each request. If you don’t, you’ll get an error message.
There are two ways to add your API key:
- In the URL: Add it after a question mark (
?
). - In the header: Add a valid API key with each request using
X-API-Key
Replace INSERT_YOUR_API_KEY_HERE
with your API key.