API-Integration

Das Pumble-API-Add-on bietet eine nahtlose Lösung, mit der Benutzer mit der Pumble-API ohne einen komplexen Autorisierungsprozess interagieren können. Mit diesem Add-on können Benutzer API-Schlüssel mühelos generieren, was ihnen ermöglicht, Nachrichten, Reaktionen usw. über einfache HTTP-Anforderungen zu senden. So legst du los:

1. Klicke auf die Schaltfläche +Apps hinzufügen in der linken Seitenleiste
   
   
   
2. Klicke auf die Schaltfläche Installieren neben der API-App 
   
   Ein neuer Tab wird mit der Einverständniserklärung und Integrationsdetails geöffnet.
   
   Es ist möglich, dass die App in deinem Arbeitsbereich von einem anderen Benutzer bereits installiert ist und dass du sie autorisieren musst, um die App benutzen zu können. Um dies zu tun, solltest du auf die Schaltfläche Autorisieren neben der App-Namen klicken.
   
   
3. Wähle einen Arbeitsbereich im Dropdown-Menü aus
   
   Es ist wichtig, dass du dich bei dem Pumble-Arbeitsbereich angemeldet hast, den du aus dem Dropdown-Menü wählst.
   
   
4. Klicke auf Zulassen, um den Vorgang abzuschließen

Gültige Befehle #

Es gibt einige bestimmte Befehle, die verwenden werden können, um mit der API-Integration in Pumble zu interagieren:

• /api-keys generate - Add-on generiert API-Schlüssel für einen bestimmten Benutzer und speichert sie in ihrer Datenbank. Benutzer können so viele API-Schlüssel generieren, wie sie möchten.
• /api-keys list - Add-on listet alle API-Schlüssel von Benutzern auf
• /api-keys help - listet alle gültigen Befehle auf, die du benutzen kannst

API-Schlüssel generieren #

So generierst du einen API-Schlüssel:

1. Gib /api-keys generate in den Nachrichten-Editor in einem Kanal ein (du kannst auch eine Notiz hinzufügen)
2. Drücke die Eingabetaste/Sendetaste, um den Vorgang abzuschließen

Du erhältst eine flüchtige Nachricht, die den generierten API-Schlüssel enthält. Diese Nachricht ist für andere Benutzer nicht sichtbar. Kopiere den Schlüssel für weitere Nutzung. Der generierte Schlüssel ermöglicht die Interaktion mit der öffentlichen API des Add-ons, wodurch Benutzer Anforderungen senden und verschiedene Aktionen in Pumble ausführen können, wie:

• Nachrichten senden
• Nachrichten beantworten
• Nachrichten löschen
• Reaktion zur Nachricht hinzufügen
• Kanal erstellen
• Nachrichten in einem Kanal auflisten (falls der Kanal privat ist, muss der Add-on-Bot Mitglied dieses Kanals sein)
• Kanäle und DMs auflisten, die zum Benutzer gehören, der den Schlüssel erstellt hat

Eine vollständige Übersicht aller verfügbaren Aktionen findest du in der Swagger-Dokumentation.

Die API-Integration kann beispielsweise von einer stark besuchten E-Commerce-Website benutzt werden, deren Kundenservice über Bestellungen in Echtzeit informiert werden soll. Indem Pumble mit API integriert wird, kann ein automatisiertes Benachrichtigungssystem eingerichtet werden, das das Kundenservice-Team in Pumble-Kanälen von einer neuen Bestellung benachrichtigt.

Mit der öffentlichen API des Add-ons interagieren #

Du kannst mit der öffentlichen API des Add-ons interagieren, um Nachrichten zu senden und andere Aktionen in Pumble mit dem generierten API-Schlüssel auszuführen.

Sende dazu einen Request über eine API-Plattform deiner Wahl (z. B. Insomnia, Postman oder JMeter).

Die vollständige Auswahl der unterstützten APIs findest du in der Dokumentation hier: https://pumble-api-keys.addons.marketplace.cake.com/

Du kannst auch die Swagger-Dokumentation nutzen. Gib dazu einfach deinen API-Key unter Authorize ein.