Authentifizierung

Sie müssen sich authentifizieren, um auf die REST-API zugreifen zu können. Dazu müssen Sie einen Bearer Token generieren, den Sie in den Request-Header einfügen.

Bearer Token

Den Bearer Token können Sie im Modul ZEP-Schnittstellen in Ihrem ZEP generieren. Hier sehen Sie ein Beispiel, wie Sie den generierten Token mit cURL in den Request-Header einfügen:

Beispiel der Authentifizierung mit Bearer Token

curl --request GET \
     --url 'https://www.zep-online.de/zepinstanz/next/api/v1/customers' \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer {token}'

⚠️

Bewahren Sie Ihren persönlichen Token immer sicher auf und setzen Sie ihn zurück, wenn Sie vermuten, dass er missbraucht wurde. Bitte übermitteln Sie Ihr ZEP Passwort und Ihren Token nicht an GitHub o.ä.

Rate Limiting

Jeder Mandant darf bis zu 1000 Anfragen pro 5 Minuten senden. Alle Tokens eines Mandanten teilen sich dieses Limit. Zusätzlich dürfen pro Mandant höchstens 25 Anfragen gleichzeitig laufen. Darüber hinaus antwortet die API mit dem HTTP-Statuscode 429.

Jede gedrosselte Antwort enthält die Header X-RateLimit-Limit (erlaubte Anfragen pro Fenster) und X-RateLimit-Remaining (verbleibende Anfragen im Fenster). Bei einer Antwort mit 401 fehlen sie.

Eine Antwort mit 429 enthält zusätzlich Retry-After (Sekunden bis zur nächsten erlaubten Anfrage) und X-RateLimit-Reset (Unix-Zeitstempel des Fensterendes). Bitte warten Sie die Zeit aus Retry-After ab, statt sofort erneut zu senden.

Antwort bei überschrittenem Limit

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."}

Für Integrationen, die viele Daten lesen:

Bleiben Sie mit den gleichzeitigen Anfragen deutlich unter der Grenze von 25 (z. B. höchstens 10).
Laden Sie jede Liste einmal pro Synchronisationslauf statt für jeden Eintrag erneut, und legen Sie vollständige Synchronisationen außerhalb der Geschäftszeiten.
Wiederholen Sie eine Anfrage nach 429 nach den Sekunden aus Retry-After, statt sie als Fehler zu behandeln.

Bitte kontaktieren Sie Ihren Kundenberater, wenn das vorgegebene Limit nicht ausreicht und Sie eine höhere Anzahl an Anfragen benötigen.

Schnellstart Paginierung