Setup für die Verwendung der Kaizala-Connectors

  • Artikel

Personas

  • Entwickler: Interne oder Drittanbieter, die Anwendungen für die organization entwickeln , die Kaizala in die Geschäftsprozesse der organization integrieren müssen. Entwickler haben beim Entwickeln der Anwendung keinen Zugriff auf den Endbenutzer (unterscheidet sich von einer Admin).
  • Admin: Benutzer, der Teil der Endgruppen ist und Administrator ist. Es wird erwartet, dass Gruppenverwaltungsaufgaben ausgeführt werden.
  • Benutzer: Kaizala-Endbenutzer

Pre-req to set-up

  • Als Entwickler:
    • Ein Office365-Konto
    • Eine registrierte Kaizala-Telefonnummer
    • Dev-Einrichtung (beliebige Plattform) zum Aufrufen der REST-API
  • Als Administrator
    • Ein Office365-Konto
    • Eine registrierte Kaizala-Telefonnummer
    • Admin einer Konversationsgruppe in Kaizala mit der registrierten Telefonnummer
  • Als Benutzer
    • Eine registrierte Kaizala-Telefonnummer
    • Mitglied einer Konversationsgruppe in Kaizala mit der registrierten Telefonnummer

Einrichtungsschritte (Entwickler- & Gruppenadministrator)

Es gibt vier Hauptinfrastrukturkomponenten, die an der Arbeit mit der Kaizala-Plattform-API beteiligt sind:

  • Steckverbinder: Alle Drittanbietersysteme, die in Kaizala integriert werden müssen, müssen bei der Kaizala-Plattform als "Connector" registriert werden und API-Token abrufen, die dem Connector entsprechen.

  • Kaizala-Verwaltungsportal: Ein Portal, um die jeweiligen Connectors von Drittanbietern zu registrieren und ihnen Zugriff auf Kaizala-Konversationsgruppen zu gewähren.

  • Tokendienst: Ein URL-Endpunkt, der von den Drittanbieter-Apps aufgerufen werden muss, um Zugriffstoken abzurufen.

  • Plattformdienst: Ein URL-Endpunkt, der bestimmte Ressourcen verfügbar macht, um verschiedene Aktionen in Kaizala auszuführen.

  • Schritt 1: Entwickler registriert einen Connector

    • Entwickler navigiert zu Kaizala-Verwaltungsportal @https://manage.kaiza.la/
    • Anmelden mit einem vorhandenen Office365-Konto
    • Registrieren Sie eine Telefonnummer im Portal, indem Sie auf "Telefonnummer hinzufügen" tippen.
      • Telefonnummer eingeben
      • Tippen Sie auf "PIN generieren".
      • Überprüfen der per SMS empfangenen PIN auf der angegebenen Telefonnummer
    • Tippen Sie im linken Menü auf "Connectors".
    • Tippen Sie auf "Connector hinzufügen".
    • Registrieren eines Connectors für das Drittanbietersystem, das die API verwendet
      • Geben Sie den Namen des Connectors und weitere Details ein. Tippen Sie auf Weiter.
      • Wählen Sie Berechtigungen aus, die für den Connector vorgesehen sind, um Zugriff auf
      • Tippen Sie auf Connector erstellen.
    • Notieren Sie sich die ID & Geheimnis, die generiert und im Portal angezeigt wird.

  • Schritt 2: Gruppen-Admin "gewährt" dem Connector Zugriff auf seine Gruppe

    • Admin navigiert zu Kaizala-Verwaltungsportal @https://manage.kaiza.la/
    • Anmelden mit einem vorhandenen Office365-Konto (SKU TBD)
    • Registrieren Sie eine Telefonnummer im Portal, indem Sie auf "Telefonnummer hinzufügen" tippen.
      • Telefonnummer eingeben
      • Tippen Sie auf "PIN generieren".
      • Überprüfen der per SMS empfangenen PIN auf der angegebenen Telefonnummer
    • Tippen Sie im linken Menü auf "Gruppen".
    • Tippen Sie auf den Gruppennamen, auf den der Connector zugreifen muss.
    • Tippen Sie auf "Connectors".
    • Wählen Sie in der Dropdownliste den Connector aus, dem Sie Zugriff gewähren möchten.
    • Tippen Sie auf "Connector hinzufügen".
    • Beachten Sie das Aktualisierungstoken, das generiert und im Portal angezeigt wird.

  • Schritt 3: Gruppierung Admin teilt das Aktualisierungstoken für den App-Entwickler

    • Admin muss das in Schritt 2 empfangene Aktualisierungstoken manuell für den App-Entwickler freigeben.

  • Schritt 4: App-Entwickler ruft die Kaizala-Plattform-Rest-API auf, um Zugriffstoken zu generieren

    • Entwickler können jetzt das Aktualisierungstoken verwenden. Eine Connector-ID und ein Connectorgeheimnis, um die REST-API aufzurufen, um Zugriffstoken zu generieren (weitere Informationen unten)

Weiter: Generieren eines Zugriffstokens
Mehr: API-Dokumentation