Ein Header ist bei einer Schnittstelle eine Zusatzangabe, die vor dem eigentlichen Inhalt einer Anfrage oder Antwort steht. Er besteht aus einem Namen und einem Wert und sagt etwa, in welchem Format Daten kommen oder wer die Anfrage stellt.
- Header
Ein Name-Wert-Paar im Kopf einer HTTP-Anfrage oder -Antwort, das Format, Anmeldung, Sprache oder Grenzen einer Übertragung beschreibt.
Beispiel: „Ohne den Header Authorization lehnt die Schnittstelle jede Anfrage als nicht angemeldet ab.“Verwandt: HTTP-Header, die allgemeine Beschreibung der Kopfzeilen von HTTP, auch für gewöhnliche Webseiten.
Welche Header bei einer API wichtig sind
Content-Type sagt, in welchem Format der Body steht, meist application/json. Accept sagt dem Server, welches Format der Aufrufer zurückhaben möchte. Authorization trägt die Anmeldung, etwa einen Bearer Token oder einen JWT.
Authorization: Bearer eyJhbGciOiJIUzI1NiIs...
Content-Type: application/json
Accept: application/jsonViele Schnittstellen schicken in der Antwort außerdem Header zu ihren Grenzen zurück, etwa wie viele Anfragen in der laufenden Minute noch erlaubt sind; mehr dazu unter Rate Limiting.
Header und Body
Die Header beschreiben die Nachricht, der Body ist die Nachricht. Daten, die verarbeitet werden sollen, gehören in den Body, Angaben darüber, wie sie zu verarbeiten sind, in die Header.
Eigene Header bei einer API
Schnittstellen dürfen eigene Header festlegen, etwa für eine Kennung, mit der sich eine Anfrage durch mehrere Systeme verfolgen lässt, oder für die gewünschte Version der Schnittstelle. Früher begannen solche Namen mit X-, heute wird das nicht mehr empfohlen, und viele Header tragen einfach einen sprechenden Namen.