Authentication
Get SetupUsing the credentials provided to you, you can access the Compliancely user interface here:
- Production: https://app1.compliancely.com/app
- API: https://app1.compliancely.com/api/v1/ {{url}}
Note: We do not recommend using of Basic Auth
Get Access Token
The Compliancely API uses a Token-based authorization so instead of an App Key and Session ID, you will just need a Token. You can get the Token in the response
For all the other calls, the Token should be sent as a header with the name “Authorization”.
API reference :
https://apideveloper.compliancely.com/reference/api_v1_auth-token_create
Postman Reference
https://www.getpostman.com/collections/b0bb53a4d2481c25a0f5
Postman Sample:
Response codes and errors
| Status Code | Response |
|---|---|
| 400 | { "username": [ "This field may not be blank."] } |
| { "password": [ "This field may not be blank."] } | |
| { "non_field_errors": [ "Unable to log in with provided credentials."] } | |
| { "username": [ "This field is required."] } | |
| { "password": [ "This field is required."] } | |
| 200 | {"token": } |
| 429 | { "detail": "Your request has been throttled due to exceeding the allowed rate limit. Please wait for 10 minutes before trying again. If this issue persists, consider adjusting the request frequency or contact support for further assistance." } |
| 500 | Internal Server Error |
| 502 | Bad Gateway |
Throttling
This API enforces throttling, allowing a maximum of 10 requests per minute (RPM). If you exceed this limit, the following error will be returned, and you will need to wait 10 minutes before retrying.
{
"detail": "Your request has been throttled due to exceeding the allowed rate limit. Please wait for 10 minutes before trying again. If this issue persists, consider adjusting the request frequency or contact support for further assistance."
}
Updated 5 days ago