Welcome to the AIQ REST 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 Reference
Visit the full reference at https://lab.alpineiq.com/swagger
AIQ Ecommerce API
AIQ Ecommerce API docs (for Blueprint) can be found here.
If you want to show loyalty points + rewards in a Blueprint build, use the /api/v2/walletendpoint. See Enhanced Integration for more information.
API limits
5 β second
120 β minute
2000 β hour
Endpoints
Your user ID will be listed here: https://lab.alpineiq.com/api/v1.1/{Endpoint}/{UUID}
It is required to pass your "Unique user ID" to each endpoint.
Header
It is required to to pass your API key as header "X-APIKEY" for all requests