Wie authentifiziere ich API-Anfragen?

Frage

Wie authentifiziere ich API-Anfragen mit einer der Zendesk v2-APIs?

Antwort

Sie müssen ein bestätigter Benutzer sein, um API-Anfragen zu stellen. Sie können API-Anfragen über die Standardauthentifizierung mit Ihrer E-Mail-Adresse und Ihrem Kennwort, mit Ihrer E-Mail-Adresse und einem API-Token oder mit einem OAuth-Zugriffstoken authentifizieren.

Je nach Authentifizierungsmethode wird der Autorisierungsheader anders gesetzt. Anmeldeinformationen, die im Payload (Body) oder der URL gesendet werden, werden nicht verarbeitet.

Dieser Beitrag enthält Informationen zu den folgenden Themen:

• Standardauthentifizierung
• API-Token
• OAuth-Zugriffstoken
• Anzeigen des Autorisierungsheaders

Standardauthentifizierung

Wenn Sie die Standardauthentifizierung verwenden, kombinieren Sie Ihre E-Mail-Adresse und Ihr Kennwort, um den Autorisierungsheader zu generieren.

Die Kombination aus E-Mail-Adresse und Kennwort muss eine Base-64-codierte Zeichenfolge sein.

Der Autorisierungsheader sollte wie folgt formatiert sein:

Authorization: Basic email_address:password

API-Token

Wenn Sie einen API-Token verwenden, kombinieren Sie Ihre E-Mail-Adresse und Ihren API-Token, um den Autorisierungsheader zu generieren.

Die Kombination aus E-Mail-Adresse und API-Token muss eine Base-64-codierte Zeichenfolge sein.

Der Autorisierungsheader sollte wie folgt formatiert sein:

Authorization: Basic email_address/token:api_token

OAuth-Zugriffstoken

Wenn Sie OAuth zur Authentifizierung verwenden, sollte der Autorisierungsheader wie folgt formatiert sein:

Authorization: Bearer oauth_access_token

Weitere Informationen finden Sie in diesem Beitrag: Verwenden der OAuth-Authentifizierung für Ihre Anwendung.

Anzeigen des Autorisierungsheaders

Wenn Sie genau sehen möchten, was von Ihrer App gesendet wird, verwenden Sie eine Seite wie http://requestb.in/. Es empfiehlt sich, Ihre Header mit denen zu vergleichen, die von einem HTTP-Ziel mit Standardauthentifizierung generiert werden. Verweisen Sie ein HTTP-Ziel auf die gleiche requestb.in-Seite und wählen Sie Test Target aus, um dies in Aktion zu sehen:

Sobald dies auf Ihr requestb.in trifft, sieht es wie folgt aus:

Die Zeichenfolge nach „Authorization: Basic" lautet dXNlckBlbWFpbC5jb206b3BlbnNlc2FtZQ==

Das ist die Base64-codierte Version des Benutzernamens/Kennworts. Um diesen Code manuell zu dekodieren, gehen Sie zu einer Seite wie https://www.base64decode.org/, fügen Sie die Zeichenfolge in das obere Feld ein und klicken Sie auf Decode:

Wenn Sie Anfragen mit Python senden, sollten Sie den Session-Header wie folgt festlegen können:

session = requests.Session()
session.headers = {'Content-Type': 'application/json', 'Authorization': 'Basic Basic_64_encoded_code'}

Weitere Informationen zur Authentifizierung finden Sie in unserer Entwicklerdokumentation (Englisch) zu Sicherheit und Authentifizierung.