HTTP-Kopfzeilen
Dieser Abschnitt beschreibt die HTTP-Header, die die API bei jeder Anfrage akzeptiert.
Inhalt-Typ
Alle Anfragen müssen eine HTTP-Kopfzeile mit dem Inhaltstyp enthalten.
Akzeptierte Content-Typen
Basisformat | Inhaltstypen | Inhaltstypen |
---|---|---|
JSON | anwendung/json | text/json ist derzeit kein akzeptierter Inhaltstyp |
Formular Daten | multipart/form-data | Nur beim Hochladen von Variationen verwendet |
Content-Type-Fehler
Antwort-Code | Anmerkungen |
---|---|
400 | Der Inhaltstyp wurde verstanden, konnte aber nicht entschlüsselt werden. Weitere Informationen werden im Antwortkörper angezeigt |
415 | Der Inhaltstyp fehlt oder wird nicht unterstützt |
Anmerkung: In Fällen, in denen der Content-Type-Header ein Problem aufweist, wird der Content-Type der Antwort das Standardformat für die API sein, derzeit application/json
Hinweis: Die API hält sich derzeit nicht an den Accept-type HTTP Header, alle Antworten werden im gleichen Content-Type wie die empfangene Anfrage gesendet, sofern der Content-Type der Anfrage gültig war
Autorisierung
Dieser Header ist optional und wird verwendet, um der API Authentifizierungsdetails für den aktuellen Benutzer zur Verfügung zu stellen, die es dem aktuellen Benutzer ermöglichen, auf eingeschränkte API-Ressourcen zuzugreifen. Token können über die Login-API bezogen werden. Ein Beispiel für einen Header ist:
Authorization: Bearer 45267dbe480c8c7d799c62ccad92cb44f67ab086
Der Autorisierungskopf akzeptiert eine Zeichenkette, die aus zwei Teilen besteht, die durch ein einzelnes Leerzeichen getrennt sind. Der erste Teil ist der Token-Typ, der zweite Teil ist das eigentliche Zugriffstoken.
Fehler bei der Autorisierung
Antwort-Code | Anmerkungen |
---|---|
400 | Ein fehlerhafter Autorisierungs-Header wurde übermittelt |
401 | Der Autorisierungskopf fehlt oder das Token war ungültig oder ist abgelaufen |
Auswahl eines Berechtigungs-Token-Typs
Bei einem Fehlschlag enthalten die Antwort-Header einen WWW-Authenticate-Header, der den Token-Typ angibt, der für den Zugriff erforderlich ist.