CareSuite Dokumentation

Demo-Client

C#

Zur Unterstützung kann ein C# Demo-Client heruntergeladen werden. Dieser Client implementiert die in dieser Dokumentation beschriebenen Features Webhooks und API.

Download

Das Archiv enthält eine Microsoft Visual Studio Projektmappe, sowie die benötigte DLL-Datei für die Verarbeitung von JSON.

https://api.caresuite.ch/csharp-demo-client.zip

In der Projektmappe sind zwei Projekte enthalten:

Webhooks

Das Projekt WebhookDemo zeigt den Ablauf einer Quittierung von Webhooks auf.

Funktionsweise

  1. Das Projekt WebhookDemo starten. In der Datei WebhookDemo.cs vorher gegebenenfalls das Secret und den Port des HTTP-Listeners anpassen. Falls sich der C#-Client und der Emulator nicht auf demselben Computer befinden muss der Port gegebenenfalls in der Firewall geöffnet werden.
  2. Webhook-Emulator herunterladen und ins Webserver-Verzeichnis kopieren.
  3. Browser öffnen und den Emulator aufrufen.
  4. Das Feld Secret ausfüllen. Der Wert muss mit dem Wert aus der Datei WebhookDemo.cs übereinstimmen. Wenn die Werte nicht identisch sind oder kein Secret angegeben wird, kann der Hash des Webhooks nicht berechnet werden. Falls sich der C#-Client und der Emulator nicht auf demselben Computer befinden, muss im Feld Ziel-URL des Emulators die URL angepasst werden.
  5. Webhook versenden. Hier klicken für mehr Informationen zur Benutzung des Emulators.
  6. Im C#-Client werden bei einem eingehenden Webhook dessen Informationen im Textfeld ausgegeben.
  7. Wenn eine verzögerte Quittierung ausgetestet werden soll, kann die Checkbox «Eingehende Webhooks verzögert quittieren» aktiviert werden. In diesem Fall wird ein Webhook sofort mit dem HTTP-Status 202 beantwortet. Nach einer simulierten Verarbeitung von fünf Sekunden wird dann der Webhook über die Test-API quittiert. Die Dauer der Verzögerung kann in der Datei WebhookDemo.cs über die Variable verzoegerungSekunden angepasst werden.

API

Mit dem Projekt ApiDemo können Ereignisse an den API-Testserver geschickt werden.

Funktionsweise

  1. Das Projekt WebhookDemo starten.
  2. Im Browser den API-Testserver unter https://test.api.caresuite.ch aufrufen. Dabei wird eine Konsumenten-ID und ein Hash-Secret generiert. Diese Werte müssen im C#-Client eingegeben werden. Falls diese zwei Werte nicht angegeben werden, kann der Hash nicht berechnet und somit die Anfrage nicht validiert werden.
  3. Im C#-Client kann mittels den Buttons «Sende Ruf» und «Sende Quittierung» ein Ereignis oder eine Quittierung an den Testserver geschickt werden. Kann die Meldung erfolgreich validiert werden, wird das Eregnis im Testserver angezeigt. Eine Quittierung blendet das Feld des Rufes nicht aus, sondern zeigt die betreffenden Daten in die Felder «Closed at» und «Duration (s)» ein.