Kaizala-API-Dokumentation

Bevor Sie beginnen, lesen Sie setup for using the Kaizala Connectors (Einrichten für die Verwendung der Kaizala-Connectors).

Stammdomäne

Die Stammdomäne zum Aufrufen der Kaizala-APIs lautet:

{endpoint-url}

	Parameter	Typ	Optional?	Beschreibung
Endpunkt-URL	endpoint-url	Zeichenfolge	Nein	Bei erfolgreicher Authentifizierung beim Generieren von Zugriffstoken wird eine Endpunkt-URL zurückgegeben, die als api-base-url für nachfolgende API-Aufrufe verwendet werden sollte.

Wenn Sie eine beliebige Kaizala-API aufrufen, können Sie den HTTP-Statuscode 308 abrufen, der angibt, dass sich die Endpunkt-URL des Benutzers geändert hat. In diesem Fall enthält der Speicherort des Antwortheaders die neue Endpunkt-URL.

Vorschlag: Clients können das Timeout so konfigurieren, dass eine Antwort von Kaizala-APIs bei 1 Minute empfangen wird.

API-Endpunkte

Die Kaizala-API wird in der sicheren Microsoft Azure-Cloud ausgeführt und interagiert mit der Kaizala-Plattform, um verschiedene Aktionen für Endbenutzer auszuführen. Die API funktioniert mit den folgenden Kaizala-Ressourcen:

• /Gruppen
• /Untergruppen
• /Mitglieder
• /Nachrichten
• /Medien
• /Aktionen
•   /Abonnenten
• /Reaktion

Kaizala-API verfügt über Drosselungsgrenzwerte von

• 100 Aufrufe pro Minute und Connector
• 300 Aufrufe pro Minute und Mandant (connectorsübergreifend)

Wenn das Drosselungslimit überschritten wird, gibt die API den Wert "Retry-After" zusammen mit dem HTTP-Statuscode 429 zurück. Der Wert "Retry-After" gibt an, wie viele Sekunden gewartet werden soll, bevor eine weitere Anforderung ausgeführt wird.

WebHooks

Die Microsoft Kaizala-API bietet Entwicklern auch eine Möglichkeit, sich über WebHooks für bestimmte Ereignisse innerhalb der Kaizala-Plattform zu registrieren.

• /webhook

Postman-Sammlung

Um unsere APIs zu testen und das Kaizala-API-Schema zu verstehen, können Sie die Postman-Sammlung importieren, die Beispiele und Schemas für alle Microsoft Kaizala-APIs enthält:

Legen Sie die folgenden Umgebungsvariablen in "Kaizala-APIs-environment" fest, bevor Sie das Postman-Projekt ausführen:

• mobile-number: Ihre Mobiltelefonnummer, die zum Aufrufen von APIs verwendet wird
• application-id: ID, die dem Connector zugeordnet ist
• application-secret: Dem Connector zugeordnetes Geheimnis

Andere Umgebungsvariablen werden automatisch aufgefüllt, während die APIs nacheinander im Postman-Projekt erwähnt werden.

Erste Schritte mit Kaizala-REST-APIs

C#-Beispiel (freigegeben)