Information
- OpenAPI version:
3.0.0
Overview
Suppress API 1.0.0
Section titled “Suppress API 1.0.0”Authentication
All API endpoints require authentication. To become authenticated you will need your Optizmo API key which is found on the SUPPRESS Account Settings page.
The API key needs to be sent with every request as an Authorization header:
Authorization: Bearer <API key>Rate Limiting
API endpoints are rate limited to ensure stable and fair access to the API.
Refer to the x-rate-limit-limit, x-rate-limit-remaining, and x-rate-limit-reset response headers for rate limit information.
Response Times
API endpoints should respond almost immediately. Where long-running processing are started (e.g. Preparing a list for download) a complementary method is provided for checking the process status.
Authentication
Section titled “ Authentication ”api_key
Section titled “api_key ”All requests to the api are authenticated using an API key generated for your client account.
To get your API key, log in to https://client.optizmo.net as an administrator and click on Settings.
Scroll down to the Optizmo API section and click Generate to produce an API Key.
This should be sent in the Authorization header as a bearer token, eg:
Authorization: Bearer optizmo_api_.....
Security scheme type: apiKey
Header parameter name: api_key