Frage
Wie authentifiziere ich API-Anfragen mit einer der Zendesk v2-APIs?
Antwort
Sie müssen ein bestätigter Benutzersein, um authentifizierte API-Anfragen zu stellen. Zur Authentifizierung von API-Anfragen können Sie die Standardauthentifizierung mit Ihrer E-Mail-Adresse und Ihrem Kennwort, Ihrer E-Mail-Adresse und einem API-Token oder einem OAuth-Zugriffstoken verwenden.
Je nach Authentifizierungsmethode wird der Autorisierungsheader anders gesetzt. Anmeldeinformationen, die im Payload oder der URL gesendet werden, werden nicht verarbeitet.
Um Informationen zu den einzelnen Authentifizierungsmethoden anzuzeigen, klicken Sie auf die entsprechenden Registerkarten.
Kennwortauthentifizierung
API-Token-Authentifizierung
OAuth-Zugriffstoken-Authentifizierung
Kennwortauthentifizierung
Wenn Sie die Standardauthentifizierung verwenden, kombinieren Sie Ihre E-Mail-Adresse und Ihr Kennwort, um den Autorisierungsheader zu generieren. Um die Standardauthentifizierung zu verwenden, aktivieren Sie den Kennwortzugriff im Admin-Center unter Apps und Integrationen > APIs > Zendesk-APIsowie im relevanten Authentifizierungsabschnitt (Teammitglied oder Endbenutzer).
Formatieren Sie die Kombination aus E-Mail-Adresse und Kennwort so, dass eine Base-64
codierte Zeichenfolge entsteht. Ein Beispiel zum Formatieren des Autorisierungsheaders finden Sie im folgenden Codeblock.
Authorization: Basic {base-64-encoded email_address:password}
API-Token-Authentifizierung
Wenn Sie ein API-Token verwenden, kombinieren Sie Ihre E-Mail-Adresse und Ihr API-Token, um den Autorisierungsheader zu generieren. Formatieren Sie die Kombination aus E-Mail-Adresse und API-Token so, dass Base-64
eine codierte Zeichenfolge entsteht. Ein Beispiel zum Formatieren des Autorisierungsheaders finden Sie im folgenden Codeblock.
Authorization: Basic {base-64-encoded email_address/token:api_token}
OAuth-Zugriffstoken-Authentifizierung
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
Um genau zu sehen, was von Ihrer App gesendet wird, verwenden Sie eine Drittanbieterseite wie Anfrage-Papierkorb. Vergleichen Sie Ihre Header mit denen, die von einem Webhook 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 die Anfrage Ihre requestb.in erreicht, sieht sie so 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.