Integrationsanleitung
Integrationsanleitung
Diese Anleitung dient Software-Partnern der CareSuite als Leitfaden für die Integration der Webhooks und CareSuite API.
Eine Übersicht aller zu integrierender Funktionen findest Du unter Integration → Checkliste.
Zur Unterstüzung haben wir einen Demo-Client in C# für Dich bereitgestellt.
Webhooks
Über die Webhooks informiert die CareSuite Partner-Systeme über Änderungen am Datenbestand. So wird z. B. das Partner-System mit allen relevanten Informationen versorgt, wenn jemand die Berechtigungen für ein spezifisches Funkelement über die CareSuite-Oberfläche verändert hat.
Verschaffe Dir einen Überblick in dem Du die Kapitel Definition und Aufbau liest. Richte Dir anschliessend Deine Entwicklungsumgebung ein.
Informiere Dich darüber, welche Konfigurationswerte auf Deiner Seite benötigt werden. Diese Werte müssen vom Systemintegrator dynamisch hinterlegt werden können (via GUI oder Config-File, etc.).
Nutze den Webhook-Emulator um sicherzustellen, dass Dein Webserver die Webhooks korrekt empfängt.
Beginne dann damit, die Signatur der Webhooks zu überprüfen.
Unabhängig davon, ob die Signatur nun korrekt ist oder nicht, muss Dein Webserver die Webhooks immer quittieren. Du findest unter Quittierung die nötigen Informationen und ein Codebeispiel dazu.
Jetzt geht es darum, dass Du die verschiedenen Webhook-Typen empfängst und in Deinem System die entsprechenden Änderungen vornimmst. Im Webhook-Emulator findest Du für jeden Webhook ein Preset, welches Du bearbeiten und an Deinen Webserver versenden kannst.
Die unter data mitgesendeten Daten entsprechen alle einem vordefinierten Schema. Stelle sicher, dass Du alle für Dein System relevanten Daten beachtest.
API
Über die API können Daten an die CareSuite gesendet werden. So können z. B. Positionsangaben von Elementen aktualisiert oder Informationen auf VisiCall-Displays angezeigt werden.
Verschaffe Dir einen Überblick in dem Du die Kapitel Definition und Aufbau liest.
Zur Entwicklung der API-Schnittstelle steht Dir ein Testserver zur Verfügung, an den Du alle Deine HTTP-Requests senden kannst.
Informiere Dich darüber, welche Konfigurationswerte auf Deiner Seite benötigt werden. Diese Werte müssen vom Systemintegrator dynamisch hinterlegt werden können (via GUI oder Config-File, etc.).
Achte beim Versand der HTTP-Requests darauf, eine korrekte Signatur zur Anfrage hinzuzufügen.
Die unter data mitzusendenden Daten entsprechen alle einem vordefinierten Schema.
Rufe kannst Du direkt an die VisiCall API senden. Für Aktualisierungen zu Positionen oder Batterieständen von Funkelementen ist die CareCall API gedacht.