Die InsuranceSuite Cloud-API

Die InsuranceSuite Cloud-API ist ein Satz von RESTful-System-APIs, die aufrufende Anwendungen verwenden können, um Daten von einer InsuranceSuite-Anwendung anzufordern oder eine Aktion in dieser einzuleiten. Diese APIs bieten Inhalt für das REST-API-Framework, der in allen InsuranceSuite-Anwendungen vorhanden ist. Die APIs werden mithilfe der Swagger 2.0-Spezifikation erstellt. Diese werden auch als System-APIs bezeichnet.

Die System-APIs können von browserbasierten Anwendungen und Service-to-Service-Anwendungen verwendet werden. In dieser Dokumentation wird der Begriff aufrufende Anwendung verwendet, um im Allgemeinen auf alle Anwendungen oder Services zu verweisen, die eine System-API aufrufen.

Aufrufen von System-APIs

Das folgende Diagramm bietet eine allgemeine Übersicht über die Interaktion zwischen der aufrufenden Anwendung und den System-APIs.


Ablauf der Anforderung an die System-API und der Antwort von diesen
  1. Die aufrufende Anwendung erstellt ein Anforderungsobjekt. Das Anforderungsobjekt besteht aus:
    • Einem Header, der Authentifizierungsinformationen und andere Metadaten enthalten kann.
    • Nutzdaten, falls erforderlich.
  2. Die aufrufende Anwendung sendet die Anforderung mithilfe eines HTTP-Befehls an die System-API.
    • Der Befehl ruft einen bestimmten API-Endpunkt auf.
    • Der Befehl kann Abfrageparameter enthalten, die die gewünschten Daten weiter identifizieren.
    • Das Anforderungsobjekt wird mit dem Befehl gesendet.
  3. Die System-API verarbeitet die Anforderung.
    • Diese Aktivität verwendet die gesamte Anwendungslogik von InsuranceSuite, z. B. Validierungslogik und Preupdate-Regeln.
    • Die Anforderung wird durch Autorisierungssteuerungen innerhalb der System-APIs eingeschränkt.
  4. Die System-API antwortet mit einem HTTP-Antwortcode (z. B. 200 für Erfolg) und einem Antwortobjekt. Das Antwortobjekt besteht aus:
    • Einem Header
    • Nutzdaten, falls erforderlich.

System-APIs und InsuranceSuite-Logik

In der Softwarebranche sind einige RESTful-APIs für die direkte Interaktion mit der Datenbank konfiguriert. Die System-APIs sind nicht für dieses Verhalten konfiguriert. Die System-APIs interagieren nur über die Ebene der Geschäftslogik der Anwendung mit Betriebsdaten. Daher nutzen die System-APIs immer die vorhandene Geschäftslogik der Anwendung.

Zum Beispiel:

  • Angenommen, ein interner Benutzer hat keine Berechtigung zum Erstellen einer Aktivität. Wenn der interne Benutzer versucht, eine Aktivität über die System-APIs zu erstellen, führt der Versuch zu einem Fehler wegen unzureichender Berechtigungen.
  • Angenommen, es gibt eine Validierungsregel, die erfordert, dass das Fälligkeitsdatum einer Aktivität in der Zukunft festgelegt wird. Wenn ein externes System versucht, eine Aktivität mit einem Fälligkeitsdatum in der Vergangenheit zu erstellen, führt der Versuch zu einem Validierungsfehler.
  • Angenommen, es gibt eine Preupdate-Regel, die eine Genehmigungsaktivität erstellt, wenn ein Dokument als „endgültig“ gekennzeichnet wird. Wenn ein externes System über eine System-API ein „endgültiges“ Dokument erstellt, erstellt die Preupdate-Regel eine Genehmigungsaktivität.