In diesem Beitrag finden Sie einen allgemeinen Überblick über die Verwaltung von Chat-API-Clients und OAuth-Token. Sie erfahren, wie Sie neue Clients erstellen und vorhandene Clients löschen sowie OAuth-Zugriffstoken erstellen und widerrufen.
API-Clients dienen zum Erstellen von OAuth-Zugriffstoken für die Authentifizierung von API-Anforderungen. Wenn Sie ein älteres Nur-Chat-Konto verwenden, haben Sie zwei Möglichkeiten, API-Anforderungen zu authentifizieren:
- Standardauthentifizierung mit Benutzername und Kennwort
- OAuth-Zugriffstoken
Wenn Sie ein Chat+Support- oder Phase 4-Konto verwenden, haben Sie nur eine Möglichkeit, API-Anforderungen zu authentifizieren:
- OAuth-Zugriffstoken
Weitere Informationen zu den Chat-Kontotypen finden Sie unter Bestimmen der verwendeten Version von Zendesk Chat. Details zur API-Authentifizierung finden Sie in der Dokumentation zur Chat-API unter Security and Authentication (Englisch).
Dieser Beitrag enthält die folgenden Abschnitte:
- Verwalten von API-Clients
- Erstellen von API-Clients
- Löschen von API-Clients
- Erstellen von Token
- Widerrufen von Token
- Weitere Ressourcen
Verwalten von API-Clients
Administratoren können alle aktiven API-Clients einfach in der Chat-Oberfläche anzeigen und löschen. Benutzer sehen nur die Clients, die sie selbst erstellt haben.
Zum Anzeigen der aktiven Clients klicken Sie im Chat-Dashboard auf Einstellungen > Konto > API und SDKs.
Hier können Sie den Client auswählen, den Sie anzeigen oder aktualisieren möchten. Außerdem haben Sie die Möglichkeit, das Client-Geheimnis neu zu generieren oder den Client zu löschen.
Erstellen von API-Clients
Wenn Sie OAuth-Token für den internen Gebrauch erstellen möchten, gehen Sie wie in diesem Abschnitt beschrieben vor. Wenn der Client für die Integration einer Drittanwendung vorgesehen ist, befolgen Sie die Installationsanweisungen des Entwicklers.
Zum Erstellen eines Clients klicken Sie im Chat-Dashboard auf Einstellungen > Konto > API und SDKs und dann auf API-Client hinzufügen.
Ausführliche Anweisungen zum Ausfüllen der Client-Felder finden Sie in der Dokumentation zur Chat-API unter Adding an API client (Englisch).
Löschen von API-Clients
Prüfen Sie vor dem Löschen eines Clients, wie sich dies auf Dienste von Drittanbietern auswirken könnte. Wenn im Client die Weiterleitungs-URL auf einen anderen Wert als „localhost“ gesetzt ist, interagiert er wahrscheinlich mit einer externen Integration. In diesem Fall müssen Sie einen anderen Client erstellen, wenn Sie diesen Client löschen. Beim Erstellen des Tokens müssen Benutzer der externen Integration dieser erneut Zugriff auf ihr Chat-Konto gewähren. Wenn die Weiterleitungs-URL auf den Wert „localhost“ gesetzt ist, wurde der Client wahrscheinlich für die interne API erstellt.
So löschen Sie einen Client
- Klicken Sie im Chat-Dashboard auf Einstellungen > Konto > API und SDKs und wählen Sie in der Liste den gewünschten Client aus.
- Klicken Sie auf Ausgewählte löschen.
Sie können API-Clients auch mit der API verwalten. Weitere Informationen finden Sie in der API-Dokumentation unter OAuth Clients (Englisch).
Erstellen von Token
Nachdem Sie einen API-Client eingerichtet haben, können Sie ein OAuth-Zugriffstoken für die Authentifizierung von API-Anforderungen erstellen.
Es gibt zwei Möglichkeiten, ein Zugriffstoken zu erstellen – eine längere, formalere Methode für Produktionsumgebungen und eine kürzere, bequemere für Testumgebungen.
Anweisungen für beide Methoden finden Sie im Beitrag Generieren eines OAuth-Tokens (integrierte Chat-Konten).
Widerrufen von Token
Ein Token kann nur von dem Benutzer widerrufen werden, der es erstellt hat. Administratoren sind nicht berechtigt, von anderen Benutzern erstellte Token zu widerrufen.
Verwenden Sie zum Widerrufen eines Tokens die OAuth Tokens API. Der Vorgang umfasst die folgenden Schritte:
- Listen Sie Ihre Token auf und bestimmen Sie die ID des Tokens, das Sie löschen möchten.
Weitere Informationen finden Sie in der API-Dokumentation unter List Tokens (Englisch).
In umfangreicheren Listen finden Sie ein Token möglicherweise leichter, wenn Sie ungefähr wissen, wann Sie es erstellt haben.
- Widerrufen Sie das Token anhand seiner ID.
Weitere Informationen finden Sie in der API-Dokumentation unter Revoke Token (Englisch).
Weitere Ressourcen
In diesem Beitrag finden Sie einen allgemeinen Überblick über API-Clients und OAuth-Zugriffstoken. Weitere Informationen finden Sie in den folgenden Beiträgen:
- OAuth Authentication in der Dokumentation zur Chat API (Englisch)
- Generieren eines OAuth-Tokens (integrierte Chat-Konten)