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 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. Formatieren Sie den Autorisierungsheader wie folgt.

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. Formatieren Sie den Autorisierungsheader wie folgt.

Authorization: Basic email_address/token:api_token

OAuth-Zugriffstoken

Wenn Sie OAuth zur Authentifizierung verwenden, formatieren Sie den Autorisierungsheader wie folgt.

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 Drittanbieterseite wie Anfragebereich. Vergleichen Sie Ihre Header mit denen, die von einem Web-Hook mit einer OAuth-Authentifizierung generiert werden. Verweisen Sie den Webhook auf Ihre URL requestb. in und klicken Sie auf der Seite Webhook hinzufügen auf Webhook testen, um diese Aktion zu sehen:

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

Der String danach Authorization: Bearer ist der API-Schlüssel, der von RequestBin in Ihren Kontoeinstellungen unter Programmatic Access bereitgestellt wird.

Wenn Sie Anfragen mit Python senden, legen Sie die Session-Header wie folgt fest.

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

Weitere Informationen finden Sie in der Dokumentation für Entwickler. Sicherheit und Authentifizierung.