📘 Allgemeine API-Ressourcen
Willkommen bei der Esadax API-Referenz. Hier finden Sie alle wichtigen Informationen, die Sie für die Interaktion mit unserer API benötigen, einschließlich Informationen zur Authentifizierung, zum Verständnis von Antwortstatus und zur Behebung von Validierungsfehlern.
Authentifizierung
Alle API-Anfragen müssen mit einem API-Token authentifiziert werden. Dies geschieht durch Hinzufügen eines Authorization-Headers zu Ihrer HTTP-Anfrage.
✅ Header-Format ändern
Authorization: Bearer XXX
Ersetzen Sie XXX durch Ihr tatsächliches API-Token.
Über API Token
- API-Token werden pro Benutzerkonto generiert.
- Jedes Token kann benutzerdefinierte Berechtigungen haben, um den Zugriff auf bestimmte Bereiche Ihres Kontos zu beschränken.
- Dadurch bleibt Ihre Integration sicher, da nur der erforderliche Zugriff gewährt wird.
➡️ Lesen Sie mehr über die Verwaltung von API-Token
API Responses
Esadax verwendet RESTful-Prinzipien und entspricht den Standard-HTTP-Response-Praktiken. Jede Antwort der API enthält einen relevanten HTTP-Statuscode, der den Erfolg oder Misserfolg Ihrer Anfrage angibt.
📊 HTTP-Statuscodes
| Code | Name | Beschreibung |
|---|---|---|
| 200 | OK | Die Anfrage wurde erfolgreich angenommen. |
| 201 | Created | Die Ressource wurde erfolgreich erstellt. |
| 202 | Akzeptiert | Die Anfrage wurde angenommen und die Verarbeitung läuft im Hintergrund weiter. |
| 204 | Kein Inhalt vorhanden | Die Anforderung wurde akzeptiert, aber es gibt keinen Inhalt zum Zurückgeben. |
| 400 | Bad Request | Bei Ihrer Anfrage ist ein Fehler aufgetreten. Überprüfen Sie die Endpunktanforderungen und versuchen Sie es erneut. |
| 401 | Unauthorized | Ungültiger API-Token. Weiterlesen. |
| 403 | Forbidden | Die Aktion ist für dieses Token oder Konto nicht zulässig. Überprüfen Sie die Token-Berechtigungen. |
| 404 | Seite nicht gefunden | Die angeforderte Ressource wurde nicht gefunden. |
| 405 | Methode nicht erlaubt | Die verwendete HTTP-Methode wird für diesen Endpunkt nicht unterstützt. |
| 408 | Request Timeout | Es gab ein Timeout auf unserer Seite. Bitte kontaktieren Sie den Support. |
| 421 | Service nicht verfügbar | Diese Seite befindet sich gerade im Aufbau. Bitte versuchen Sie es später erneut. |
| 422 | Unverarbeitbare Entität | Es ist ein Validierungsfehler aufgetreten. Überprüfen Sie und versuchen Sie es erneut. Weiterlesen |
| 429 | Zu viele Anfragen | Rate Limit überschritten. Weitere Informationen zu Geschwindigkeitsbegrenzungen |
| 500 | Fehler 404 - Interner Serverfehler | Es ist ein Fehler aufgetreten. Bitte kontaktieren Sie den Support. |
| 502 | Bad Gateway | Temporäres Systemproblem. Bitte kontaktieren Sie den Support. |
| 503 | Service nicht verfügbar | Diese Website ist derzeit nicht erreichbar. Bitte kontaktieren Sie den Support. |
| 504 | Gateway Timeout | Es gab eine Zeitüberschreitung auf unserem System. Bitte kontaktieren Sie den Support. |
🔗 Weitere Informationen zu HTTP-Statuscodes finden Sie auf Mozilla Developer Network.
Validierungsfehler
Validierungsfehler (HTTP 422) treten auf, wenn Ihre Anforderungs-Payload nicht die Anforderungen für einen bestimmten Endpunkt erfüllt. Dies kann folgende Ursachen haben:
- Fehlende Pflichtfelder
- Ungültige Datenformate
- Fehlerhafte Parameter
Überprüfen Sie immer noch einmal die API-Endpunktdokumentation, um sicherzustellen, dass der Anforderungstext dem erwarteten Format entspricht.
