Erste Schritte

Fehler

Wenn etwas schiefgeht, antwortet die API mit dem passenden HTTP-Status und einem Body mit code und message innerhalb von error.

Werten Sie in Ihrem Programm code aus. message ist ein englischer Text, der bei der Fehlersuche hilft, und kann sich ändern.

Fehlerformat404

{
  "error": {
    "code": "not_found",
    "message": "Item not found or you do not have access to it."
  }
}

Kein Schlüssel401

{
  "error": {
    "code": "missing_api_key",
    "message": "Send your API key in the X-API-Key header or as Authorization: Bearer <key>."
  }
}

Fehlercodes

Status	Code	Wann er auftritt
400	`key_in_query`	Der Schlüssel wurde in der URL gesendet (Parameter `api_key`, `apikey`, `key` oder `token`). Senden Sie ihn im Header und generieren Sie einen neuen Schlüssel, da der bisherige in Logs gespeichert worden sein könnte.
400	`invalid_parameter`	Ein Parameter hat einen ungültigen Wert, z. B. `per_page` über dem Maximum.
401	`missing_api_key`	Die Anfrage enthielt keinen Schlüssel.
401	`invalid_api_key`	Der Schlüssel existiert nicht, wurde widerrufen oder sein Benutzer ist deaktiviert.
404	`not_found`	Der Endpunkt existiert nicht, oder das Element existiert nicht bzw. gehört zu einer Organisation, die der Benutzer nicht sehen kann.
404	`organization_not_found`	Der angegebene Wert für `organization` gehört zu keiner Organisation, in der der Benutzer diese Art von Elementen sehen kann.
405	`method_not_allowed`	Die API akzeptiert nur `GET` (und `HEAD`).
429	`rate_limited`	Das Anfragelimit wurde erreicht. Warten Sie die in `Retry-After` angegebenen Sekunden ab.
500	`server_error`	Interner Fehler. Versuchen Sie es gleich noch einmal; wenn der Fehler bestehen bleibt, kontaktieren Sie den Support.

Wann Sie es erneut versuchen sollten

Wiederholen Sie dieselbe Anfrage nur nach einem 429 (nach Ablauf von Retry-After) oder einem 500. Andere Fehler erfordern eine Korrektur der Anfrage oder des Schlüssels.