Errors and limits
The format of an error message, all error codes, the rate limit per key and other limits.
The error format#
Every error has the same shape:
{
"error": {"code": "E_SCOPE", "message": "Deze sleutel heeft de bevoegdheid invoices:read niet."},
"request_id": "6f1c2a3e-0000-4000-8000-000000000000"
}Use code in your program; message is an explanation for people (in English or Dutch) and may change. State the request_id (also in the x-request-id header) when you contact support.
Error codes#
| HTTP | Code | Meaning |
|---|---|---|
| 400 | E_VALIDATION | Invalid input, for example a wrong limit, an invalid date or an unknown customer_id. message says what. |
| 401 | E_AUTH | Key missing, invalid, revoked or expired. |
| 403 | E_SCOPE | The key does not have the required permission. |
| 404 | E_UNKNOWN | Unknown path. |
| 404 | E_NOT_FOUND | The shipment does not exist (or does not belong to this company). |
| 405 | E_METHOD | Wrong method; the Allow header says which ones work. |
| 413 | E_TOO_LARGE | The body is larger than 64 KB. |
| 429 | E_RATE | Too many calls; see below. |
| 500 | E_SERVER | Temporary error on the server. Try again later. |
Rate limit#
- Every key has a limit per minute, by default 60 calls per minute, in fixed windows of one minute.
- The
x-ratelimit-limitheader in every response gives your key's limit. - When you exceed it you get
429withE_RATEand the headerRetry-After: 60. Wait and try again. - Too many calls with an invalid key from the same address are also answered with
429for a while.
Other limits#
| Limit | Value |
|---|---|
| Body size | 64 KB |
limit per page | 1 to 200, default 50 |
| Open transport requests per customer | 30 |
| Active keys per company | 20 |
| Webhooks per company | 10 |
| Response time of your webhook address | 10 seconds |
Log#
Per call INTEGALL only records the operation, the status, the duration and the key prefix, never the key itself or the content. The call log is deleted after 90 days.