API
To get started developing on the AIQ system you will need to obtain an API key and authorize your first request.
- Login to the AIQ customer portal
- Navigate to "Settings" in the left nav bar
- Click on "API" in the tab options on the top of the settings page
- Copy your API key via the input field
If you would like a sandbox account, please reach out to our support team for approval. Once you have your API key you will be ready to call our endpoints.
API limits
API limits: 5 – second, 120 – minute, 2000 – hour
Endpoints
It is required to pass your "Unique user ID" to each endpoint. In the screenshot above you will see "Your UID for requests is: 1". Your user ID will be listed here: https://lab.alpineiq.com/api/v1.1/{Endpoint}/{UUID}
Header
It is required to to pass your API key as header "X-APIKEY" for all requests
Please visit our most common use cases here: https://support.alpineiq.com/common-use-cases
Visit the full reference at https://lab.alpineiq.com/swagger
