Authentication
How to securely authenticate your requests with BlitzAPI.BlitzAPI uses API Keys to authenticate requests. You can view and manage your API keys in the BlitzAPI Dashboard.
The x-api-key Header
Authentication to the API is handled via an HTTP header. Include your API key in every request using the x-api-key header.
Example Request
Here is how to set the header in various environments:Verifying your Key
To check if your key is active, use theGET /v2/account/key-info endpoint. This is a great way to “health check” your integration before running batch jobs.
Errors
If authentication fails, the API will return a401 Unauthorized error.
For every other status code, including
422 validation errors, see Errors.
