API Key
Need an API Key? Click here!
Authentication
API requests must include an AdeptID API key in the authentication header:
Set the HTTP header X-API-KEY: <AdeptID API Key> on the request.
Enable JSON content
AdeptID APIs send and respond to JSON. Set the following HTTP headers on all requests to enable sending and receiving JSON:
Content-Type: application/json
Accept: application/json
Compress Payloads
AdeptID recommends always compressing inbound payloads. The default inbound payload is limited to 20MB.
To send compressed payloads:
- Add or enable gzip compression in your client code. Many HTTP client libraries support this natively, but the payload can also be compressed as a step before sending the request.
- Set the HTTP header
Content-Encoding: gzipon the request.
API Versioning
We periodically release new, dated versions of the API whenever we make breaking changes. We try to only make backwards compatible changes, but sometimes we have to make a breaking change to iterate on the API.
We consider the following changes backwards compatible:
- Adding new API endpoints
- Adding new optional parameters to existing endpoints
- Adding new data elements to existing responses
- Adding new errors
- Changing parameters from “Required” to “Optional”