API-Fehler: Antwortcodes und request_id
Bei einem API-Fehler gibt der NN Agent ein JSON mit einer Fehlerbeschreibung und der Anfrage-ID zurück.
{
"error": { "code": "unauthorized", "message": "Missing bearer token" },
"request_id": "f04e847d-8505-4b7b-a5c8-7aee42a8fc55"
}Feld request_id#
request_id — eindeutiger Identifikator eines bestimmten Aufrufs. Protokollieren Sie ihn auf Ihrer Seite: Der Support findet die Anfrage in den Protokollen, ohne nach Zeit, Körper und Kopfzeilen zu fragen. Ohne ihn wird die Analyse eines fehlgeschlagenen Aufrufs zu einem eintägigen Schriftwechsel.
Antwortcodes#
| Code | Wann tritt es auf | Was zu tun ist |
|---|---|---|
200 |
Die Anfrage wurde ausgeführt | — |
401 |
Der Header Authorization fehlt oder das Token ist ungültig oder abgelaufen |
Überprüfen Sie die Authentifizierung |
404 |
Die Adresse existiert nicht. Die Antwortform unterscheidet sich: {"detail":"Not Found"} |
Vergleichen Sie den Pfad und die Version mit dem Handbuch |
422 |
Der Körper oder die Parameter haben die Validierung nicht bestanden | Siehe detail — dort ist aufgeführt, welches Feld und warum abgelehnt wurde |
Formular für Validierungsfehler#
Antwort 422 enthält eine Liste der problematischen Felder: für jedes ist der Ort in der Anfrage (loc), die Nachricht (msg) und der Fehlertyp (type) angegeben.
{
"detail": [
{ "loc": ["body", "field_name"], "msg": "field required", "type": "value_error.missing" }
]
}Zertifikatfehler — kein API-Fehler#
Wenn der Client die Verbindung bei der Überprüfung des TLS-Zertifikats unterbricht, gibt es keine Antwort vom API: api.nexifyneo.com gibt ein selbstsigniertes Zertifikat zurück. Ein solcher Fehler hat keinen Code und kein request_id, und es ist sinnlos, danach in den API-Logs zu suchen. Einzelheiten — Bekannte Einschränkungen.
Weiter#
- Authentifizierung — wie man ein Token überträgt.
- API-Übersicht — Zusammensetzung der Operationen und Unterschiede zwischen den Versionen.