Bei Anfragen, die Sunshine Conversations APIs verwenden, ist eine Authentifizierung erforderlich, um die Identität des Anrufers zu überprüfen. Sie können entweder die Standardauthentifizierung oder JSON Web Tokens (JWTs) verwenden, um die Identität eines Anrufers zu überprüfen. Für beide Methoden ist ein API-Schlüssel erforderlich. Sie erstellen den API-Schlüssel auf der Seite für die Conversations API.
Die Seite für die Conversations API ist beim Zendesk Suite Professional-Plänen oder höher verfügbar. Diese Seite wird nur angezeigt, wenn Sie den Zendesk-Arbeitsbereich für Agenten aktiviert haben. Zusätzliche Add-on-Pakete sind erhältlich, wenn Sie mehr monatlich aktive Nutzer (MAU) oder Benachrichtigungen benötigen. Weitere Informationen finden Sie im Beitrag Überblick über Add-ons für die Zendesk Suite.
Dieser Beitrag enthält die folgenden Abschnitte:
Überblick über API-Schlüssel
Ein API-Schlüssel identifiziert und authentifiziert eine Anwendung oder einen Benutzer und besteht aus drei Teilen:
- Die App-ID identifiziert Ihr Zendesk-Konto.
- Die Schlüssel-ID wird zusammen mit dem Geheimschlüssel zur Authentifizierung von JWTs und API-Aufrufen verwendet.
- Der Geheimschlüssel ist das Authentifizierungskennwort.
Bei der Standardauthentifizierung reichen Sie Anfragen direkt mit einem API-Schlüssel ein. Die Schlüssel-ID ist der Benutzername und der Geheimschlüssel ist das Kennwort.
Bei JWTs signieren Sie Token mit einem API-Schlüssel, die dann zur Authentifizierung bei der API verwendet werden. Die Schlüssel-ID ist im JWT-Header als Eigenschaft kid enthalten, während der Geheimschlüssel das JWT signiert.
API-Schlüssel sind nicht so sicher wie Authentifizierungs-Tokens. Achten Sie bei der Verwendung eines API-Schlüssels in der Produktionsinstanz auf die Einhaltung von Best Practices zum sicheren Umgang mit Anmeldedaten.
Weitere Informationen zur Authentifizierung bei Sunshine Conversations finden Sie unter API Authentication (Englisch).
Der Sunshine Conversations API-Schlüssel unterscheidet sich von den Messaging-Authentifizierungsschlüsseln. Messaging-Authentifizierungsschlüssel werden verwendet, um Anmeldeinformationen zu signieren, die Endbenutzer über Zendesk-SDKs authentifizieren. Der API-Schlüssel hier ist für Server-zu-Server-Aufrufe gedacht und ermöglicht den Zugriff auf die öffentlichen APIs von Sunshine Conversations, die den Gültigkeitsbereich appunterstützen.
Erstellen und Teilen der IDs und des API-Schlüssels
Ein Zendesk-Administrator muss einen API-Schlüssel erstellen und ihn mit dem Entwickler teilen. Sie können bis zu 10 Schlüssel speichern.
So erstellen und teilen Sie einen API-Schlüssel
-
Klicken Sie in der Seitenleiste des Admin Centers auf
Apps und Integrationen und dann auf APIs > Conversations API.
Hinweis: Um dieses Fenster einzublenden, brauchen Sie mindestens einen Zendesk Suite Professional-Plan. - Klicken Sie auf API-Schlüssel erstellen.
Wenn Sie Ihren ersten Schlüssel erstellen, wird diese Schaltfläche unten auf der Seite angezeigt. Haben Sie bereits einen Schlüssel erstellt, erscheint sie in der rechten oberen Ecke.
- Geben Sie im Dialogfeld „Neuen Schlüssel erstellen“ einen aussagekräftigen Namen für den Schlüssel ein und klicken Sie dann auf Weiter.
- Klicken Sie im Dialogfeld „Geteilten Schlüssel kopieren“ für jede ID und jeden Geheimschlüssel auf Kopieren, um die Daten in der Zwischenablage zu speichern, und dann auf Weiter.
Sie kehren zum API-Fenster zurück. Der neue Schlüssel ist jetzt in der Liste aufgeführt.
Wenn Sie Ihr Limit von 10 Schlüsseln erreicht haben, werden Sie beim Generieren eines weiteren Schlüssels aufgefordert, einen ungenutzten Schlüssel zu löschen.
So löschen Sie einen ungenutzten Schlüssel
- Klicken Sie in der Seitenleiste des Admin Centers auf Apps und Integrationen und dann auf APIs > Conversations API.
- Setzen Sie den Mauszeiger auf den Schlüssel, den Sie löschen möchten, klicken Sie auf das Optionsmenü (
) und dann auf Löschen. - Klicken Sie auf Löschen, um den Vorgang zu bestätigen.