Public API 2.0 Reference
API v1 has been updated with many new features, performance improvements, and a brand new roadmap that will empower our merchants to do so much more with our Public API.
Why Switch?
Massive performance improvements: most if not all endpoints are operating anywhere between 1.5x and 8x faster than our previous implementation.
Stricter internal security.
Support for Tiers
A roadmap that will allow you to do many new and powerful things with our Public API.
Public API v1 will sunset in May of 2024!
Authentication
API Keys are private and should not be shared or exposed on the front end.
Using API Key in Requests
As with v1, authentication is done via the request header. Include your API key as an X-Inveterate-Api-Key header on all API endpoint requests.
API URL
All API requests utilize https://public.inveterateapi.com/v2.0/ as the base URL. If you have any issues, double check that you are prepending with https:// and appending /v2.0.
Example Get Request
Admin vs Storefront
As of now, admin and storefront methods operate in the same way--use the same API key in the header to authenticate both kinds of endpoints. The admin endpoints were created to model after admin actions within the merchant dashboard, while the storefront was made to model data that members are allowed to access.
In the (near) future, storefront endpoints will have their own "storefront" authentication through Shopify using a member's credentials. This will allow you to build authenticated apps and services outside of the Inveterate/Shopify ecosystem.
The storefront endpoints will always support authentication via the X-Inveterate-Api-Key, however.
Last updated