Zendesk Chat API nutzen: Eine Schritt-für-Schritt-Anleitung

Sie möchten also eine benutzerdefinierte Integration erstellen, einige Chat-Daten für einen Bericht abrufen oder ein paar Arbeitsabläufe in Zendesk automatisieren. Das ist ein großartiges Ziel. Die Verwendung der API gibt Ihnen die Möglichkeit, die Plattform wirklich nach Ihren Wünschen zu gestalten.

Aber seien wir mal ehrlich. Herauszufinden, wo man bei den Zendesk-APIs überhaupt anfangen soll, kann sich wie ein Albtraum anfühlen. Es gibt den klassischen Live-Chat, die neuere Messaging-Plattform und ein ganzes Sammelsurium verschiedener APIs zur Auswahl: REST, Real-Time, Conversations… das ist genug, um den Browser-Tab am liebsten wieder zu schließen, bevor man überhaupt eine einzige Zeile Code geschrieben hat.

Wenn Ihnen das bekannt vorkommt, sind Sie hier genau richtig. Dieser Leitfaden soll Licht ins Dunkel bringen. Wir führen Sie durch einen einfachen, schrittweisen Prozess zur Verwendung der klassischen Chat-API, die Zendesk bereitstellt. Wir werden die Verwirrung beseitigen und Sie vom Kopfzerbrechen zu Ihrem ersten erfolgreichen API-Aufruf führen.

Was Sie für den Einstieg in die Zendesk Chat-API benötigen

Bevor wir die Ärmel hochkrempeln und uns in den Code stürzen, lassen Sie uns kurz überprüfen, ob Sie alles haben, was Sie brauchen. Wenn Sie das jetzt klären, ersparen Sie sich später eine Menge Ärger.

Hier ist eine kurze Checkliste:

• Ein Zendesk-Konto mit API-Zugriff. Dies ist normalerweise bei Zendesk Suite Team-Plänen und höher verfügbar. Wenn Sie nicht sicher sind, welchen Plan Sie haben, lohnt es sich, einen Blick auf Ihre Abonnementdetails zu werfen, um dies zu bestätigen.

• Administratorrechte. Sie müssen Administrator in Ihrem Zendesk-Konto sein, um die API-Schlüssel zu generieren. Wenn Sie kein Administrator sind, müssen Sie die Person finden, die es ist, und sie höflich um Hilfe bitten.

• Ein API-Client. Sie benötigen eine Möglichkeit, Anfragen an die API zu senden. Ein Tool wie Postman ist dafür fantastisch, da es Ihnen ermöglicht, API-Aufrufe mit einer benutzerfreundlichen Oberfläche zu testen, anstatt sofort Code zu schreiben. Alternativ können Sie cURL direkt im Terminal Ihres Computers verwenden oder direkt in Ihre bevorzugte Programmiersprache einsteigen.

• Grundkenntnisse von REST-APIs. Sie müssen kein Experte sein, aber eine gewisse Vertrautheit mit Konzepten wie Endpunkten, GET-Anfragen und Autorisierungs-Headern wird diesen Prozess wesentlich reibungsloser gestalten.

Eine schrittweise Anleitung zur Verwendung der Zendesk Chat-API

Also gut, da Sie nun alle Ihre Werkzeuge bereit haben, lassen Sie uns zur Sache kommen. Wir werden zunächst die Zendesk-Landschaft verstehen und uns dann mit einem echten API-Aufruf die Hände schmutzig machen.

Schritt 1: Die Landschaft der Zendesk Chat-API verstehen (Chat vs. Messaging)

Ehrlich gesagt ist der größte Verwirrungspunkt für jeden, der mit Zendesk-APIs beginnt, der Unterschied zwischen ihren beiden Chat-Produkten: Live-Chat und Messaging. Sie klingen ähnlich, aber unter der Haube sind sie völlig unterschiedliche Paar Schuhe, die völlig unterschiedliche API-Sätze verwenden. Dies von Anfang an klarzustellen, ist entscheidend.

Zendesk Live-Chat (Der Klassiker)

Dies ist das ursprüngliche, sitzungsbasierte Chat-Produkt, mit dem viele von uns vertraut sind (früher Zopim genannt). Stellen Sie es sich wie einen Anruf vor: Ein Kunde startet einen Chat, es ist eine Live-Konversation in Echtzeit, und sie endet, wenn er das Fenster schließt. Dieses Produkt verwendet einen spezifischen Satz von APIs, einschließlich der Chat-REST-API, auf die wir uns in diesem Leitfaden konzentrieren werden. Diese APIs sind darauf ausgelegt, diese Echtzeit-Konversationen zu verwalten, Agenten zu handhaben und historische Chat-Protokolle aus diesem klassischen System abzurufen.

Zendesk Messaging

Dies ist Zendesks neuerer, Omnichannel-Ansatz. Er ist für asynchrone Konversationen konzipiert, was eher dem Senden von SMS oder WhatsApp ähnelt. Ein Kunde kann eine Nachricht von Ihrer Website, Ihrer mobilen App oder sogar über den Facebook Messenger senden und später zurückkehren, um die Antwort zu sehen. Hier ist der entscheidende Punkt: Messaging verwendet die klassischen Chat-APIs überhaupt nicht. Stattdessen stützt es sich auf ein anderes Entwickler-Toolkit, einschließlich Dingen wie Sunshine Conversations und Webhooks für Echtzeitdaten.

Diese Trennung ist ein echtes Kopfzerbrechen für Teams, die versuchen, einheitliche Automatisierungen zu erstellen. Das Jonglieren mit zwei völlig unterschiedlichen API-Modellen ist kompliziert und kann viel Zeit und Ressourcen verschlingen. Es ist ein häufiger Grund, warum so viele dieser Projekte in der Entwicklung stecken bleiben. Genau deshalb existieren Plattformen wie eesel AI. Sie bietet eine einzige, Ein-Klick-Integration mit Zendesk, die sich mit all Ihren Helpdesk-Daten verbindet, egal ob sie aus dem klassischen Chat oder dem modernen Messaging stammen. Dies ermöglicht es Ihnen, intelligente KI-Agenten zu erstellen, ohne sich Gedanken darüber machen zu müssen, welche API Sie verwenden sollen.

Schritt 2: Wählen Sie die richtige API für Ihr Ziel

Selbst in der Welt des traditionellen Live-Chats bietet Ihnen Zendesk einige verschiedene APIs, die jeweils für eine bestimmte Aufgabe konzipiert sind. Die richtige von Anfang an zu wählen, wird Ihnen ersparen, sich im Kreis zu drehen.

Hier ist eine kurze Übersicht Ihrer Optionen:

• Chat-REST-API: Dies ist das Arbeitspferd, das Sie für die meisten Dinge verwenden werden. Sie würden diese verwenden, um programmatisch historische Chat-Daten abzurufen, Transkripte zu holen, Ihre Agenten zu verwalten und Chat-Informationen nach Abschluss einer Konversation zu aktualisieren. Wir werden diese API in unserem Beispiel unten verwenden.

• Echtzeit-Chat-API: Dies ist eine Streaming-API, die entwickelt wurde, um zu überwachen, was gerade jetzt passiert. Wenn Sie ein Dashboard erstellen müssen, das anzeigt, wie viele Chats aktiv sind oder welche Agenten in diesem Moment online sind, ist dies die richtige API für Sie.

• Conversations API (GraphQL): Diese API wurde ursprünglich für die Erstellung von Anwendungen konzipiert, die sich wie Agenten verhalten können, wie z. B. benutzerdefinierte Chatbots. Zendesk hat diese API jedoch in den Wartungsmodus versetzt und sie ist für neue Integrationen nicht mehr verfügbar. Für jedes neue Projekt sollten Sie diese API meiden.

• Web SDK: Dies ist keine typische API, sondern eine JavaScript-Bibliothek, die auf der Client-Seite lebt. Sie gibt Ihnen die Möglichkeit, ein vollständig benutzerdefiniertes Chat-Widget für Ihre Website zu erstellen, was Ihnen die totale Kontrolle über Aussehen, Verhalten und Benutzererfahrung gibt.

Um es noch deutlicher zu machen, hier ist eine einfache Tabelle, die Ihnen bei der Entscheidung helfen soll:

Schritt 3: Generieren Sie Ihre API-Anmeldeinformationen

Um sicher mit der API zu kommunizieren, muss Ihr Code nachweisen, dass er die Berechtigung hat. Der Standardweg dafür ist die Erstellung eines OAuth-Clients in Ihrem Zendesk-Chat-Dashboard, der Ihnen die Anmeldeinformationen gibt, die Sie zur Generierung eines Zugriffstokens benötigen.

So geht’s:

1. Gehen Sie zu Ihrem Zendesk-Chat-Dashboard. Sie finden dies normalerweise in der Produktleiste (das Symbol mit den vier Quadraten) in Ihrem Hauptkonto von Zendesk Support.

2. Navigieren Sie im Menü auf der linken Seite zu Einstellungen > Konto und klicken Sie dann auf den Tab API & SDKs.

3. Klicken Sie auf die große Schaltfläche API-Client hinzufügen.

4. Sie sehen ein Formular. Geben Sie Ihrem Client einen einprägsamen Client-Namen (etwas wie „Chat-Daten-Integration“ funktioniert gut) und füllen Sie Ihren Firmennamen aus. Für die Weiterleitungs-URLs können Sie vorerst einfach „https://localhost“ eingeben. Dies ist ein Platzhalter, der für den Authentifizierungsfluss erforderlich ist, und er ist für das, was wir heute tun, völlig in Ordnung.

5. Nachdem Sie den Client erstellt haben, zeigt Ihnen Zendesk eine Client-ID und ein Client-Secret. Kopieren Sie das Client-Secret und speichern Sie es an einem sicheren Ort, wie einem Passwort-Manager. Dies ist Ihre einzige Gelegenheit, es zu sehen.

6. Diese Anmeldeinformationen werden in einem Prozess namens OAuth-Autorisierungsfluss verwendet, um ein temporäres Bearer-Token zu erhalten. Um diesen Leitfaden einfach zu halten, spulen wir vor und gehen davon aus, dass Sie ein Zugriffstoken generiert haben, das Sie direkt in Ihren Anfragen verwenden können.

Schritt 4: Machen Sie Ihren ersten API-Aufruf

Und nun zum Moment der Wahrheit. Lassen Sie uns die soeben generierten Anmeldeinformationen verwenden, um echte Daten aus Ihrem Konto abzurufen. Unser Ziel ist einfach: eine Liste Ihrer letzten Chats abrufen.

Der Endpunkt

Der API-Endpunkt ist einfach die URL, an die Sie Ihre Anfrage senden. Um eine Liste aller Chats zu erhalten, lautet der Endpunkt "GET /api/v2/chats".

Authentifizierung

Jede Anfrage, die Sie senden, muss authentifiziert werden, um zu beweisen, dass Sie es sind. Sie tun dies, indem Sie Ihr Zugriffstoken in einen "Authorization"-Header aufnehmen. Das Format ist einfach: "Authorization: Bearer IHR_ZUGRIFFSTOKEN".

Alles zusammenfügen (cURL-Beispiel)

Die Verwendung von cURL von Ihrem Terminal aus ist eine der schnellsten Möglichkeiten, eine API ohne viel Aufhebens zu testen. Öffnen Sie Ihr Terminal, ersetzen Sie IHR_ZUGRIFFSTOKEN durch das tatsächliche Token, das Sie haben, und führen Sie diesen Befehl aus:

"`bash

curl https://www.zopim.com/api/v2/chats \

-H "Authorization: Bearer IHR_ZUGRIFFSTOKEN"

"`

Wenn alles korrekt eingerichtet wurde, sollte der Zendesk-Server mit einer Menge JSON-formatiertem Text antworten, der eine Liste Ihrer Chats enthält.

Beispielantwort

Die Antwort wird ein JSON-Array von Chat-Objekten sein. Hier ist ein vereinfachter Ausschnitt, wie das aussehen könnte:

"`json

{

"chats": [

{  

  "id": "1A2B3C4D5E",  

  "visitor": {  

    "name": "Jane Doe",  

    "email": "jane.doe@example.com"  

  },  

  "history": [  

    {  

      "type": "chat.msg",  

      "display_name": "Jane Doe",  

      "msg": "Hallo, ich habe eine Frage zu meiner letzten Bestellung.",  

      "timestamp": 1678886400000  

    },  

    {  

      "type": "chat.msg",  

      "display_name": "Support-Agent",  

      "msg": "Hallo Jane, ich helfe Ihnen gerne dabei!",  

      "timestamp": 1678886460000  

    }  

  ],  

  "timestamp": "2023-03-15T12:00:00Z"  

}  

],

"count": 1

}

"`

Und genau so haben Sie es geschafft! Sie haben die von Zendesk bereitgestellte Chat-API erfolgreich verwendet, um echte Daten abzurufen. Sie können hier alle möglichen nützlichen Informationen sehen, wie die Chat-ID, Besucherdetails und den vollständigen Gesprächsverlauf mit Zeitstempeln.

Häufige Fehler, die bei der Arbeit mit der Zendesk Chat-API zu vermeiden sind

Ihren ersten API-Aufruf zum Laufen zu bringen, ist ein großartiger erster Schritt, aber wenn Sie anfangen, fortgeschrittenere Integrationen zu erstellen, gibt es einige häufige Fallen, in die man leicht tappen kann. Hier sind einige freundliche Ratschläge, die Ihnen helfen, sie zu umgehen.

• 1. Die falsche API für die Aufgabe verwenden: Wir haben es schon ein paar Mal erwähnt, aber es lohnt sich, es zu wiederholen, weil es der Fehler Nummer eins ist, den die Leute machen. Bevor Sie eine Zeile Code schreiben, überprüfen Sie, ob Ihr Ziel den klassischen Live-Chat oder das moderne Messaging betrifft. Der Versuch, Messaging-Daten mit der Chat-API abzurufen, wird einfach nicht funktionieren und Sie werden sich fragen, warum nichts angezeigt wird.

• 2. Ratenbegrenzungen ignorieren: Um ihren Dienst für alle stabil zu halten, hat die Chat-API von Zendesk eine Ratenbegrenzung, die typischerweise bei etwa 200 Anfragen pro Minute liegt. Wenn Sie dieses Limit überschreiten, erhalten Sie einen Fehler „429 Too Many Requests“. Eine gute Vorgehensweise ist es, immer den „X-Rate-Limit-Remaining“-Header in der API-Antwort zu überprüfen, um zu sehen, wie viele Aufrufe Sie noch haben, und eine einfache Logik in Ihrer Anwendung zu erstellen, um zu pausieren, wenn Sie sich dem Limit nähern.

• 3. Ein neues Projekt auf einer veralteten API aufbauen: Wie wir bereits erwähnt haben, befindet sich die Conversations API im Wartungsmodus. Sie mag leistungsfähig aussehen, aber ein neues Projekt auf einer API zu starten, die von Zendesk nicht mehr aktiv weiterentwickelt wird, bereitet Ihnen nur zukünftige Probleme. Halten Sie sich für jede neue Arbeit an die aktiv unterstützten APIs.

Diese Art von Herausforderungen verdeutlicht die versteckten Kosten beim Aufbau und der Wartung von benutzerdefinierten Integrationen. Es ist nicht nur die anfängliche Zeit, die zum Schreiben des Codes benötigt wird; es ist die laufende Arbeit, Fehler zu behandeln, sich an API-Änderungen anzupassen und die gesamte technische Wartung zu verwalten. An diesem Punkt könnten Sie sich fragen, ob es sich lohnt, von Grund auf neu zu bauen. Für einen winzigen Bruchteil des Entwicklungsaufwands bietet ein Tool wie eesel AI eine leistungsstarke Simulations-Engine, mit der Sie die Leistung Ihrer KI an Tausenden von historischen Tickets testen können, bevor sie jemals mit einem echten Kunden interagiert. Sie können anspruchsvolle Automatisierungen mit Zuversicht und ohne Entwicklungsrisiko einsetzen.

Überspringen Sie den Code der Zendesk Chat-API und automatisieren Sie mit KI

Herzlichen Glückwunsch! Sie haben sich durch die manchmal verwirrende Welt der von Zendesk bereitgestellten Chat-API gekämpft, von der Generierung Ihrer Anmeldeinformationen bis hin zum Abrufen echter Daten. Das ist eine solide Grundlage für den Aufbau jeglicher benutzerdefinierter Tools, die Sie im Sinn haben.

Wenn Ihr oberstes Ziel jedoch darin besteht, Lösungen zu automatisieren, Ihre Agenten effizienter zu machen und Kunden sofortige Antworten zu geben, ist der Eigenbau ein langer Weg, der viel Entwicklerzeit erfordert. Es gibt einen viel schnelleren Weg, dorthin zu gelangen.

eesel AI lässt sich in nur wenigen Minuten direkt in Ihre Zendesk-Instanz integrieren und bietet Ihnen ein komplettes Set an KI-Tools direkt nach dem Auspacken. Von einem autonomen Agenten, der Tickets selbstständig lösen kann, bis hin zu einem KI-Copiloten, der Ihren menschlichen Agenten Superkräfte verleiht, können Sie in Minuten statt in Monaten einsatzbereit sein. Sie erhalten alle Vorteile leistungsstarker Automatisierung ohne die technischen Kopfschmerzen.

Ein KI-Copilot, der eine Antwort in Zendesk entwirft, eine Alternative zum Programmieren mit der Zendesk Chat-API.

Starten Sie noch heute Ihre kostenlose Testversion.