Connect ist die Programmierschnittstelle von Praecura. Drittsysteme übernehmen darüber Bestände, lesen Vertrags- und Kundendaten, legen Umdeckungen an und hängen Dokumente an. Angesprochen wird sie mit API-Keys, die ein Administrator in der Verwaltung anlegt.
Das Modul wird je Instanz freigeschaltet. Ohne Freischaltung antworten alle Endpunkte mit einem Fehler.
Funktionen
| Funktion | Zweck |
|---|---|
| Offlineverträge importieren | Verträge aus Fremdsystemen in den Bestand übernehmen und aktuell halten. |
| Umdeckung anlegen | Umdeckungskandidaten aus importierten Verträgen auf ein Praecura-Produkt anlegen, auch in großen Stückzahlen. |
| Vertrags- und Kundendaten | Verträge lesen sowie Kunden lesen, anlegen, ändern und löschen. |
| Dokumente (File) | Dokumente hochladen, mit einer Dokumentart versehen und Verträgen oder Kunden zuordnen. |
Weitere Endpunkte sind auf den Seiten ihrer Module beschrieben:
Schadenmeldungen anlegen und lesen (Schadenmanagement)
Organisationen und Benutzer lesen, Versicherungsgesellschaften pflegen
Unterschriftsanfragen aus einer Dokumentvorlage erzeugen (Dokumentenmanagement)
Schnittstellenreferenz
Die maßgebliche Referenz mit Endpunkten, Feldern und Beispielen ist unter /api/connect/v1.json der Instanz als OpenAPI-Dokument abrufbar.
Jeder Endpunkt trägt dort eine Stabilitätsstufe:
ohne Kennzeichnung: stabil
„experimental“: kann sich noch ändern
„deprecated“: wird abgelöst, für neue Anbindungen nicht mehr verwenden
API-Keys
Einstieg: Basisdaten > Schnittstellen & API > Connect API-Keys. Nur für Benutzer, die die Systemeinstellungen bearbeiten dürfen.
Ein API-Key hat eine Laufzeit (1 Tag, 1 Woche, 1 Monat oder 1 Jahr) und eine Auswahl von Berechtigungen (Scopes). Jeder Endpunkt verlangt einen bestimmten Scope, z.B. „Verträge lesen“. Die Liste zeigt je Key Laufzeit und letzte Nutzung.
Beim Anlegen werden Name, Laufzeit und Berechtigungen gewählt. Der Schlüssel wird nur einmal angezeigt.
Abgelaufene und unbekannte Keys sowie Keys ohne passenden Scope werden abgewiesen.
Schnittstellen-Logs
Einstieg: Basisdaten > Schnittstellen & API > Schnittstellen Logs. Erfordert das Recht, Schnittstellen-Logs zu lesen.
Die Logs protokollieren ausgehende Aufrufe an externe Systeme und Zustellereignisse des E-Mail-Dienstes:
BiPRO-Anfragen an Versicherer
E-Mail- und SMS-Versand, E-Post
Sanktionslistenprüfung
ZÜRS-Abfragen
Filter: Zeitraum, Status, Methode, Endpunkt und Pfad. Die Detailansicht zeigt Anfrage und Antwort und verlinkt den zugehörigen Vorgang. Aufrufe der Connect-Schnittstelle selbst erscheinen hier nicht.
BiPRO-Anbindung
Für einzelne Produkte holt Praecura Angebote über die BiPRO-Schnittstelle direkt beim Versicherer ab und übermittelt den Abschluss. Ob ein Produkt die Anbindung nutzt, ist in der Produktdefinition festgelegt.
Unter Einstellungen > Schnittstellen & API > Externe Schnittstellen ist BiPRO als Leistung „auf Anfrage“ aufgeführt.
Export von Listen
Listen der Verwaltung, etwa Kunden, Verträge oder Schäden, lassen sich über „Exportieren“ als CSV oder XLSX herunterladen, mit den sichtbaren oder allen Spalten. Die Funktion wird je Instanz freigeschaltet.
Allgemeine Regeln für alle Endpunkte
Authentifizierung mit dem API-Key als Bearer-Token. Fehlender oder ungültiger Key: 401, fehlender Scope: 403.
Fehler kommen als JSON mit festem Fehlercode, optional dem betroffenen Feld und einer Meldung. Die Codes je Endpunkt stehen in der Referenz.
Listen werden seitenweise mit „limit“ und „offset“ ausgegeben. Die Angabe, ob weitere Seiten folgen, ist gesetzt, sobald eine Seite voll ist. Die letzte Seite kann deshalb leer sein.
Je Aufrufer sind etwa 10 Anfragen pro Sekunde vorgesehen, darüber antwortet die Schnittstelle mit 429 und einer Wartezeit.
Abgerechnet wird nach Anzahl der Aufrufe.