Sandbox – Industrie: Anleitung

Einführung

Dies ist eine Schritt für Schritt Anleitung zur Verwendung der Sandbox „Industrie“. Die Sandbox bildet einen Use Case ab bei dem ein Dokument „Versicherungsbestätigung“ angefordert und synchron zur Verfügung gestellt wird. Der Gesamtprozess sieht wie folgt aus:

Schritt 1: Sandbox aufrufen

Die Sandbox im Browser aufrufen und auf InsuranceCertificates klicken:

Nun sieht man die beiden modellierten Endpunkte der Schnittstelle und kann sie als Klappfelder per Mausklick öffnen und schließen:

Schritt 2: Anfordern der Versicherungsbestätigung.

Hierzu beim „POST“ zunächst den Button „Try it out“ anklicken:

Im Bereich „Example Value“ lässt sich der POST-Request im JSON-Format ausfüllen. Hier ist z.B. die Versicherungsnummer (policyId) mit dem Wert „1234“ befüllt worden:

Ggf. sollte man jetzt etwas nach unten scrollen und sieht den blauen Button „Execute“:

Per Klick auf den blauen Button wird eine Versicherungsbestätigung zum Vertrag mit der Versicherungsnummer „1234“ angefordert. Wenn man nun noch weiter herunter scrollt sieht man den Response:

In diesem Beispiel war der Request in Ordnung und man bekommt als Antwort einen HTTP-Code 202 sowie eine Vorgangsnummer „1“ im „Response Body“. Diese sollte man sich für den folgenden Schritt merken.

Schritt 3: Versicherungsbestätigung abholen

Jetzt kann man (optional) den POST-Bereich (per Klick oben auf POST) wieder zuklappen und sollte den GET-Bereich aufklappen. Beim „GET“ klickt man zunächst auf den „Try it out“ Button und muss jetzt nur noch die aus Schritt 2 erhaltene Vorgangsnummer in das Feld certificateID eintragen sowie den weiter unten liegenden blauen Button „Execute“ anklicken:

Als Antwort erhält man eine JSON mit einem base64-codierten String (insuranceCertificate) sowie der Art der Versicherungsbestätigung (certificateType):

Es ist üblich Dokumente in dieser Form (base64-codiert) zu übertragen, allerdings kann man eine Umformatierung vornehmen, um die erhaltene Datei als PDF anschauen zu können. Dazu kann man den String („JVBERioxL…“) im Screenshot oben kopieren und z.B. mit einem Online-Tool wie base64.guru eine Umwandlung vornehmen. Der codierte String wird in diesem Tool in das Feld „Base64*“ eingefügt. Per Klick auf den Button „Decode Base64 to PDF“ erhält man eine PDF-Datei mit der im POST ursprünglich eingegebenen policyId im Feld „Vertragsnummer“:

Tipps und Hinweise

Die Sandbox ist in der Tat als Spielwiese zu verstehen. Man kann hier verschiedene Dinge ausprobieren (und auch Mal bewusst Fehler generieren zum Beispiel) ohne die Sorge etwas „kaputt zu machen“.