API & Integrationen

Alles, was Sie auf den Seiten Anrufe und Kundensupport tun können, lässt sich auch über Ihre eigenen Systeme erledigen: einen Helpdesk, eine Website, eine Telefonanlage oder Ihre eigene Software. Öffnen Sie im Dashboard API & Integrationen. Nur Organisationsinhaber und Administratoren können die Einstellungen verwalten. Alles, was darüber ausgeführt wird, wird der Organisation genauso in Rechnung gestellt wie dieselbe Aktion im Dashboard.

Die technischen Details, Beispiele und die vollständige API-Referenz finden Sie in der Entwicklerdokumentation. In diesem Artikel erfahren Sie, wofür die einzelnen Bereiche gedacht sind.

Unterstützte IntegrationenFragen

Spiiksi funktioniert mit den folgenden Tools. Für jedes gibt es eine Schritt-für-Schritt-Anleitung in der Entwicklerdokumentation.

Alle Integrationen sind unter Connectors aufgeführt. Über eine Integration gestartete Anrufe erscheinen unter Anrufe, wo Mitarbeitende daran teilnehmen können.

Telefonnummern und Teams einrichten

Twilio, SIP und Teams richten Sie im Dashboard unter Connectors auf der Seite API & Integrationen ein:

• Twilio: Geben Sie Ihre Twilio-Daten ein, klicken Sie auf Verbinden und fügen Sie die Voice-Webhook-URL (in Twilio einfügen) in den Einstellungen Ihrer Telefonnummer bei Twilio ein.
• SIP: Erstellen Sie eine Eintrags-ID und kopieren Sie den Wählplan in Ihre Telefonanlage.
• Teams: Erstellen Sie in Ihrem Team einen ausgehenden Webhook und fügen Sie dessen Sicherheitstoken ein.

Helpdesk-Apps einrichten

Zendesk, Freshdesk, Salesforce und Genesys Cloud werden in den jeweiligen Tools installiert. Erstellen Sie einen API-Schlüssel für die App (siehe unten), laden Sie die App über die zugehörige Anleitung herunter und folgen Sie den dort beschriebenen Schritten.

API-SchlüsselFragen

Ihre Systeme verwenden einen API-Schlüssel, um mit Spiiksi zu kommunizieren. Wie Sie den Schlüssel mit jeder Anfrage übermitteln, erfahren Sie unter Authentifizierung.

1. Beschreiben Sie unter API-Schlüssel, wofür der Schlüssel gedacht ist, zum Beispiel „Zendesk“.
2. Wählen Sie den Modus: Live für den produktiven Einsatz oder Test, um Dinge auszuprobieren (siehe unten).
3. Lassen Sie unter Was der Schlüssel tun darf alles aktiviert oder erlauben Sie nur, was das System benötigt, zum Beispiel nur Text zu übersetzen oder nur Anrufe anzuzeigen.
4. Klicken Sie auf Schlüssel erstellen und kopieren Sie den Schlüssel sofort. Er wird nicht noch einmal angezeigt. Speichern Sie ihn auf Ihrem Server, niemals auf einer Webseite.

Mit Widerrufen wird ein Schlüssel sofort deaktiviert, zum Beispiel wenn er möglicherweise in falsche Hände geraten ist. In der Liste sehen Sie, wann jeder Schlüssel zuletzt verwendet wurde.

TestmodusFragen

Mit einem Test-Schlüssel werden Texte mit einer Platzhalterübersetzung übersetzt, Anrufe leiten die Stimmen ohne Übersetzung weiter und es entstehen keine Kosten. Der Schlüssel hat nur Zugriff auf Inhalte, die mit Testschlüsseln erstellt wurden, niemals auf Ihre echten Anrufe und Unterhaltungen. Verwenden Sie ihn beim Entwickeln einer Integration und wechseln Sie anschließend zu einem Live-Schlüssel.

WebhooksFragen

Ein Webhook benachrichtigt Ihren Server, wenn etwas passiert: ein Anruf beginnt oder endet, ein Chat beginnt, eine Nachricht erhält oder geschlossen wird.

In der Entwicklerdokumentation unter Webhooks erfahren Sie, welche Informationen die einzelnen Benachrichtigungen enthalten und wie Sie ihre Signatur überprüfen.

1. Geben Sie unter Webhooks die Webhook-Adresse Ihres Servers ein, wählen Sie die Veranstaltungen (oder Alle Veranstaltungen) aus und klicken Sie auf Webhook hinzufügen.
2. Kopieren Sie das Signaturgeheimnis. Es wird nicht noch einmal angezeigt. Ihr Server verwendet es, um zu prüfen, ob die jeweilige Zustellung tatsächlich von Spiiksi stammt.
3. Mit Testen wird eine Testzustellung gesendet und angezeigt, wie Ihr Server darauf geantwortet hat.

Wenn Ihr Server nicht antwortet, versucht Spiiksi es etwa eineinhalb Tage lang erneut und verlängert dabei schrittweise die Abstände. Unter Zustellungen sehen Sie jede einzelne Zustellung und ob sie angekommen ist. Mit Erneut senden können Sie eine Zustellung noch einmal senden. Nach zehn fehlgeschlagenen Zustellungen in Folge wird der Webhook pausiert. Aktivieren Sie dann den Schalter Aktiv wieder, sobald Ihr Server wieder funktioniert.

OAuth-AppsFragen

Eine OAuth-App ist für Software gedacht, mit der sich viele Organisationen verbinden, zum Beispiel eine App im Marketplace eines Helpdesks. Statt einen API-Schlüssel weiterzugeben, genehmigt der Administrator jeder Organisation die App in Spiiksi und kann die Verbindung jederzeit trennen.

• Wenn Sie eine solche App entwickeln: Lesen Sie die OAuth-Dokumentation und registrieren Sie die App unter OAuth-Apps mit ihrem App-Namen und den Weiterleitungs-URIs (https, durch Leerzeichen getrennt). Sie erhalten eine Client-ID und ein Client-Geheimnis.
• Wenn Sie die App eines anderen Anbieters verbinden: Spiiksi zeigt Ihnen, was die App tun möchte und für welche Organisation. Klicken Sie auf Erlauben. Verbundene Apps werden unter Mit dieser Organisation verbundene Apps aufgeführt. Mit Trennen wird ihr Zugriff sofort beendet.

Website-Chat und Ihre eigenen SeitenFragen

• Eine Chat-Schaltfläche auf Ihrer Website öffnet Unterhaltungen im Kundensupport. Weitere Informationen finden Sie unter Kundensupport.
• Anrufe und Chats können mit dem JavaScript SDK auch direkt auf Ihren eigenen Seiten geöffnet werden, in einem Pop-up oder als Teil der Seite (/docs/javascript-sdk).

SicherheitFragen

• Speichern Sie API-Schlüssel und Geheimnisse auf Ihrem Server. Jede Person mit einem Schlüssel kann ihn verwenden, und die Kosten werden Ihrer Organisation in Rechnung gestellt.
• Verwenden Sie für jedes System einen eigenen Schlüssel mit nur den erforderlichen Berechtigungen. So können Sie einen Schlüssel widerrufen, ohne die anderen Systeme zu unterbrechen.
• Spiiksi speichert nur einen Fingerabdruck jedes API-Schlüssels und jedes Client-Geheimnisses der App, nicht den Schlüssel selbst. Deshalb kann er nicht noch einmal angezeigt werden.