Für den Zugriff auf die Zendesk-API können die Benutzer zwei Authentifizierungsmethoden verwenden: 1. ein automatisch generiertes Kennwort (API-Token) und 2. ein OAuth-Zugriffstoken (nicht mit dem API-Token identisch).
Beide Authentifizierungsmethoden sind in neuen Konten standardmäßig deaktiviert. In diesem Beitrag wird erläutert, wie Sie die einzelnen Methoden aktivieren und deaktivieren können, um den Zugriff von Benutzern auf die Zendesk-API zu steuern.
Weitere Informationen zur Nutzung der Zendesk API finden Sie auf den folgenden Seiten:
Verwalten des Zugriffs auf die API per API-Token
Benutzer können ein API-Token verwenden, um API-Anfragen zu authentifizieren. API-Tokens sind automatisch generierte Kennwörter, die zusammen mit dem Benutzernamen verwendet werden können, um API-Anfragen zu authentifizieren. API-Token können auch für die Zwei-Faktor-Authentifizierung bei Integrationen genutzt werden. Jedes API-Token kann von jedem bestätigten Benutzer des Kontos verwendet werden; es ist nicht mit einem bestimmten Benutzer verknüpft. Es können mehrere Token gleichzeitig aktiv sein.
API-Token sind nicht das gleiche wie OAuth-Zugriffstoken. Weitere Informationen finden Sie unter Differences between API tokens and access tokens (Englisch) auf developer.zendesk.com.
Wie Sie ein API-Token zur Authentifizierung von API-Anfragen verwenden, erfahren Sie unter API token (Englisch) auf developer.zendesk.com.
Aktivieren des API-Tokenzugriffs
Der API-Tokenzugriff ist standardmäßig deaktiviert. Sie müssen den API-Tokenzugriff im Admin Center aktivieren, bevor Benutzer API-Token verwenden können.
So aktivieren Sie den API-Tokenzugriff
- Klicken Sie in der Seitenleiste des Admin Centers auf
Apps und Integrationen und dann auf APIs > Zendesk-API. - Aktivieren Sie den Tokenzugriff in der Registerkarte „Einstellungen“.
Generieren von API-Token
Um API-Token generieren zu können, müssen Sie ein Administrator sein und der API-Tokenzugriff muss in Ihrem Konto aktiviert sein.
So generieren Sie ein API-Token
- Klicken Sie in der Seitenleiste des Admin Centers auf Apps und Integrationen und dann auf APIs > Zendesk-API.
- Klicken Sie auf die Schaltfläche API-Token hinzufügen rechts neben Aktive API-Token.
Das Token wird generiert und angezeigt:
- (Optional) Geben Sie eine Beschreibung für das API-Token ein.
- Kopieren Sie das Token und fügen Sie es an einem sicheren Ort ein. Nachdem Sie dieses Fenster durch Klicken auf Speichern geschlossen haben, wird das vollständige Token nicht wieder angezeigt.
- Klicken Sie auf Speichern, um zur Seite „Zendesk API“ zurückzukehren.
Wenn Sie auf das Token klicken, um es erneut zu öffnen, wird eine verkürzte Version des Tokens angezeigt.
Löschen eines API-Tokens
Ein API-Token ist wie ein Kennwort: Jeder bestätigte Benutzer des Kontos oder jeder, der die E-Mail-Adresse eines bestätigten Benutzers hat, kann es zur Authentifizierung von API-Anfragen verwenden. Wenn ein API-Token unberechtigt verwendet wurde, sollten Sie es sofort löschen. Wenn Sie ein Token löschen, wird es dauerhaft deaktiviert.
So löschen Sie ein API-Token
- Klicken Sie in der Seitenleiste des Admin Centers auf Apps und Integrationen und dann auf APIs > Zendesk-API.
- Wählen Sie das Token in der Liste aus und klicken Sie rechts auf Löschen.
Verwalten des Zugriffs auf die API per OAuth-Token
Sie können OAuth-Zugriffstoken verwenden, um API-Anfragen zu authentifizieren. OAuth ist eine sichere Möglichkeit für Anwendungen, auf Zendesk-Daten zuzugreifen, ohne API-Token (sensible Informationen!) speichern und verwenden zu müssen.
Im Gegensatz zu API-Token können OAuth-Zugriffstoken nicht direkt im Admin Center erstellt werden. Sie müssen zuerst einen OAuth-Client im Admin Center erstellen und dann den OAuth-Client in einem definierten OAuth-Autorisierungsflow verwenden, um ein OAuth-Zugriffstoken zu erstellen.
OAuth-Zugriffstoken sind nicht das gleiche wie API-Token. Weitere Informationen finden Sie unter Differences between API tokens and access tokens (Englisch) auf developer.zendesk.com.
In diesem Abschnitt werden folgende Themen behandelt:
- Erstellen von OAuth-Clients
- Erstellen von Zugriffstoken mit einem OAuth-Client
- Löschen von OAuth-Clients und Token
Wie Sie API-Anfragen mit OAuth-Zugriffstoken authentifizieren, erfahren Sie unter OAuth access token (Englisch) auf developer.zendesk.com.
Erstellen von OAuth-Clients
Mit OAuth-Clients können Sie OAuth-Zugriffstoken zur Authentifizierung von API-Anfragen erstellen. OAuth-Zugriffstoken unterscheiden sich von API-Token. OAuth-Zugriffstoken sind eine sichere Methode für Anwendungen, auf die Zendesk-API zuzugreifen, ohne dass die API-Token von Zendesk-Benutzern gespeichert und verwendet werden müssen.
So erstellen Sie einen OAuth-Client
- Klicken Sie in der Seitenleiste des Admin Centers auf Apps und Integrationen und dann auf APIs > Zendesk-API.
- Klicken Sie auf die Registerkarte OAuth-Clients .
- Um einen Client zu erstellen, klicken Sie auf die Schaltfläche OAuth-Client hinzufügen und befolgen Sie die Anweisungen unter Registrieren Ihrer Anwendung bei Zendesk.
- Um einen Client zu löschen, wählen Sie den Client in der Liste aus und klicken Sie dann rechts auf Löschen.
Verwenden Sie dann den OAuth-Client, um ein oder mehrere OAuth-Zugriffstoken zu erstellen.
Erstellen von Zugriffstoken mit einem OAuth-Client
Nachdem Sie einen OAuth-Client im Admin Center erstellt haben, können Sie ihn in einem definierten Autorisierungsflow verwenden, um OAuth-Zugriffstoken zu erstellen.
Sie können den OAuth-Client auch in Verbindung mit der API verwenden, um Zugriffstoken ohne Autorisierungsfluss zu erstellen. Sie können ein API-Token verwenden, um API-Anfragen zu authentifizieren. Weitere Informationen finden Sie unter Creating and using OAuth access tokens with the API (Englisch) auf developer.zendesk.com.
Löschen von OAuth-Clients und Token
Sie können einen OAuth-Client löschen, um alle mit dem Client erstellten Zugriffstoken zu deaktivieren. Sie können auch einzelne Zugriffstoken widerrufen.
So löschen Sie einen OAuth-Client
- Klicken Sie in der Seitenleiste des Admin Centers auf Apps und Integrationen und dann auf APIs > Zendesk-API.
- Klicken Sie auf die Registerkarte OAuth-Clients .
- Wählen Sie den Client in der Liste aus und klicken Sie rechts auf Löschen.
So widerrufen Sie ein bestimmtes Zugriffstoken
- Befolgen Sie die Anweisungen unter Revoking an access token (Englisch) auf developer.zendesk.com.