SmartCompare | Dokumentation Qernel API
Art der Schnittstelle: RESTful + XML / Diese Schnittstelle ist eine RESTful Schnittstelle, die mit einem XML Body arbeitet.
Die folgenden Endpunkte stehen zur Verfügung:
Tarifierung/Angebot/Antrag
Aufbau des XML (Request Body)
Der Aufbau des XML setzt sich zusammen aus einem Bereich <client> und einem Bereich <data>, die innerhalb eines Tags <request> liegen.
Die Methode (<method>) beschreibt die Art des Requests. Mögliche Eingaben sind: preis, angebot, antrag, gen_antrag
Es wird eine XML-Struktur zurückgegeben.
Beispiel (Antrag):
<request> <client> <user>vertragspartner</user> <pass>******</pass> <subuser>hauptmandant</subuser> <subsubuser>untermandant</subsubuser> <subsubpass>******</subsubpass> <method>antrag</method> <!-- die preisid wird im Response des Preisrequests im Bereich "event[level=info] text" zurückgegeben. //--> <!-- Im Antrag ist sie optional, im Angebot muss sie zwingend übergeben werden //--> <preisid>******</preisid> <!-- features ist optional, beschreibt zusätzliche Inhalte im Response //--> <!-- 0: kein Leistungsvergleich //--> <!-- 1: Leistungsvergleich mit Anzahl erfüllter Leistungen //--> <!-- 2: Leistungsvergleich mit gewählten Ausprägungen //--> <!-- 3: Leistungsvergleich mit allen Ausprägungen //--> <features>2</features> <!-- feature ist optional, beschreibt Leistungseinschlüsse, bitte hierfür gezielt nachfragen //--> <feature id="*****" choice="0" /> <feature id="*****" choice="0" /> <!-- das Package (im Beispiel KRAVAG) repräsentiert den Tarif eines Versicherers, die Vermittlernummer ist im Antrag verpflichtend //--> <package id="52" vermittlernummer="*****" /> </client> <data>(siehe unten)</data> <!-- im Falle eines Antragsrequests (<method>antrag</method>) ist es darüber hinaus möglich, eine PDF-Datei als Antrags-Dokument im Format Base64 encoded binary string mitzusenden. //--> <!-- <file description="Antrag" name="Antrag.pdf">...</file> //--> </request>
Der Aufbau des Bereichs <data> unterscheidet sich je Produkt und wird in den folgenden Unterseiten beschrieben, die Sie durch einen Klick auf das gewünschte Produkt erreichen können.
Response-Struktur (für method=preis):
<response> <events> <!-- es gibt im Preis Response nur ein einziges Element mit level=info, welches immer die preisid (siehe oben) enthält //--> <event level="info"> <text>d9ba69172cd470864c470e0bb1890eee1e6ff171</text> <time>2025-03-25T14:15:49</time> <generator>Qernel::Container</generator> </event> </events> <results> <!-- pro Tarif wird ein result Element ausgegeben //--> <result>...</result> <result>...</result> <result>...</result> </results> </response>
Dokumentendownload
Anhänge wie Informationsblatt, AGB, Datenschutzvereinbarung, etc. können als Dokumente über folgenden Endpunkt heruntergeladen werden. So können die Informationen je Tarif abgerufen werden.
Es wird eine JSON-Struktur zurückgegeben.
Beispiel: https://smartinsurtech-qernel.innosystems.net/ws/pkw/data/documents?beginn=04.03.2021&package=119
Beispiel-Response:
[ { "description": "Informationsblatt zu Versicherungsprodukten", "type": "info", "url": "https://smartinsurtech-docs.innosystems.net/pkw/19120/200042_IPID_KFZ.pdf" }, { "description": "Kfz-Umweltschadenversicherung", "type": "info", "url": "https://smartinsurtech-docs.innosystems.net/pkw/19120/B_250057_01_2016.pdf" }, { "description": "Allgemeine Bedingungen für die Kfz-Versicherung", "type": "info", "url": "https://smartinsurtech-docs.innosystems.net/pkw/19120/B_250063_AKB_2020.pdf" }, { "description": "Datenschutzhinweise", "type": "info", "url": "https://smartinsurtech-docs.innosystems.net/pkw/19120/B_490968_DSVGO_Infopflichten_Kunden_Antrag_Sach.pdf" } ]