Authentication
You must authenticate yourself in order to access the REST API. To do this, you must generate a Bearer Token, which you insert into the request header.
Bearer Token
You can generate the bearer token in the ZEP interfaces module in your ZEP. Here you can see an example of how to insert the generated token into the request header using cURL:
curl --request GET \
--url 'https://www.zep-online.de/zepinstanz/next/api/v1/customers' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {token}'Always keep your personal token safe and reset it if you suspect that it has been misused. Please do not send your ZEP password and token to GitHub or similar.
Rate Limiting
Every tenant may send up to 1000 requests per 5 minutes. All tokens of a tenant share this limit. In addition, at most 25 requests per tenant may run at the same time. Beyond either limit, the API answers with HTTP status code 429.
Every throttled response carries the headers X-RateLimit-Limit (requests allowed per window) and X-RateLimit-Remaining (requests left in the window). They are absent on a 401 response.
A 429 response additionally carries Retry-After (seconds until the next allowed request) and X-RateLimit-Reset (Unix timestamp of the window end). Please wait for the time given in Retry-After rather than retrying at once.
HTTP/1.1 429 Too Many Requests
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 0
Retry-After: 30
X-RateLimit-Reset: 1790000000
Content-Type: application/json
{"message": "Too Many Attempts."}For integrations that read a lot of data:
- Stay well below the limit of 25 concurrent requests (e.g. at most 10).
- Load each list once per sync run instead of again for every item, and run full syncs outside business hours.
- Retry a
429after theRetry-Afterseconds instead of treating it as an error.
Please contact your customer advisor if the specified limit is not sufficient and you require a higher number of requests.