Inbox API - Einrichtung und technische Dokumentation

Die Inbox API erlaubt das erstellen von Tickets in der Inbox und ermöglicht damit die Integration von Kanälen die der SocialHub noch nicht unterstützt. So können beispielsweise die Kommentare der eigenen Webseite in die SocialHub-Inbox einfließen, auch wenn diese nicht auf WordPress basiert. Hierzu bedarf es natürlich der Eigenentwicklung eines Programms das die Kommentare an die Inbox API sendet.

Hierbei handelt es sich um ein Feature das zuvor für deinen Account freigeschaltet werden muss. Schreib uns eine kurze E-Mail an happy@socialhub.io, dass du dieses Feature nutzen möchtest.

Für SocialHub-Admins

Einen Custom Channel anlegen

Damit ein Entwickler die Inbox API nutzen kann muss ein Admin des SocialHub-Accounts zunächst einen "Custom Channel" anlegen. Wenn die Inbox API für den Account aktiviert ist, erscheint unter Account > Kanäle der Bereich "Inbox API".

Kazam_screenshot_00010.png

Per Klick auf "Kanal hinzufügen" wird ein Formular geöffnet in dem ein Name und ein Bild für den Kanal vergeben werden muss. Das Bild wird als Symbol für Tickets die über die Inbox API erstellt wurden verwendet. Nachdem der Kanal gespeichert wurde wird unter der Bestätigungsmeldung ein sogenannter Zugriffsschlüssel angezeigt. Mit diesem Zugriffsschlüssel kann ein Entwickler auf unsere API zugreifen und Tickets für den erstellen.

Über Zugriffsschlüssel

Manchmal ist es nötig einen aktuellen Zugriffsschlüssel zu ersetzen (z.B. wenn dieser aus irgendeinem Grund nicht mehr geheim ist). Im Normalfall kommt dann der für den Custom Channel zuständige Entwickler in eurem Unternehmen auf dich zu. In diesem Fall kann ein neuer Zugriffsschlüssel generiert werden. Achtung: Dabei wird der bisherige Zugriffsschlüssel deaktiviert und die Ticket-API kann mit diesem nicht mehr genutzt werden. Daher sollte nur in Absprache mit dem in eurem Unternehmen für den betreffenden Custom Channel zuständigen Entwickler ein neuer Schlüssel generiert werden.

Kazam_screenshot_00009.png

Wird ein Custom Channel gelöscht oder deaktiviert ist der Zugriff auf die API nicht mehr möglich. Wird der Kanal später wieder aktiviert erhält er einen neuen Schlüssel.

Ein Entwickler kann mithilfe des Zugriffsschlüssels eines Custom Channels über die Ticket-API aktuell diese Aktionen ausführen:

  • Neue Tickets innerhalb des Custom Channels erstellen

Er kann damit nicht:

  • Tickets für andere Custom Channels oder Kanäle erstellen
  • Tickets aus dem SocialHub auslesen oder bearbeiten
  • Zugriff auf andere Kanäle erhalten

Für Entwickler

Wir haben alles was eure Entwickler dazu wissen müssen auf unserer Webseite SocialHub for Developers zusammengefasst: Technische Dokumentation der Inbox API


Du hast Feedback / Vorschläge hierzu oder es gibt Probleme mit den hier beschriebenen Informationen?
Schreib uns eine E-Mail an support@socialhub.io und wir werden versuchen, so schnell wie möglich zu helfen.

Haben Sie Fragen? Anfrage einreichen

Kommentare