Monitor Handbuch

Informationen zum Dokument und Nutzungsanweisungen

Dieses Dokument beschreibt die relevanten technischen Regeln bezüglich des Inso-Biz-Monitors.

Diese Dokumentation und dazugehörige Dokumente unterliegen dem Urheberschutz. Alle Rechte, insbesondere das Recht der Vervielfältigung, Weitergabe oder Übersetzung, sind vorbehalten.

Kein Teil der Dokumentation darf ohne vorherige schriftliche Zustimmung der STP Business Information GmbH in irgendeiner Form vervielfältigt, verarbeitet oder weitergegeben werden. Einige der in dieser Veröffentlichung genannten Bezeichnungen sind ebenfalls eingetragene Marken der jeweiligen Anbieter und unterliegen als solche den gesetzlichen Bestimmungen.

Die Informationen in diesem Dokument wurden mit Sorgfalt zusammengestellt. Es wird jedoch keine Garantie für deren Vollständigkeit, Richtigkeit und Verwendbarkeit übernommen. Im Falle von Unterschieden zwischen der englischen und der deutschen Version gilt ausschließlich die deutsche Version. STP Business Information GmbH übernimmt keine Haftung für Schäden, die aus der Nutzung dieser Dokumentation entstehen könnten. Die hierin enthaltenen Informationen können im Laufe der Weiterentwicklung ohne vorherige Ankündigung geändert, gelöscht oder ergänzt werden.

© STP Business Information GmbH. Alle Rechte vorbehalten.

Einleitung

Der Insolvenz- und Biz-Monitor überwacht einen übermittelten Personen- und/oder Firmenbestand (=Eingabedaten), abhängig von der gewählten Ausprägung, auf aktuelle Insolvenzinformationen und/oder publizitätspflichtig Handelsregistermeldungen. Er liefert aktuelle Benachrichtigungen zu wichtigen Veränderungen, z.B. über die Eröffnung eines neuen Insolvenzverfahrens und übernimmt weiterhin die Überwachung des Fortgangs des Verfahrens. Die Nachricht (=Ergebnis) umfasst neben den Daten zur Person oder der Firma alle relevanten Termine des Verfahrens und nennt das zuständige Gericht sowie den Insolvenzverwalter. Gleichzeitig stellt der Insolvenz- und Biz-Monitor aktuell im Handelsregister publizierte Veränderungen zum Kunden- und Lieferantenstamms oder auch eines möglicher potentiellen Klientel bereit. Das sind zum Beispiel Wechsel der Geschäftsadresse oder im Management, Kapitalmaßnahmen, Liquidationen, etc.

REST-API Dokumentation

Eine ausführliche Beschreibung der Endpunkte finden Sie in unserer Monitor Swagger API-Dokumentation

Monitor Prozessbeschreibung

Der Monitoring-Prozess besteht aus drei Schritten.

• Anlegen der Kundenliste
• Dem Monitoring
• Abrufen der Ergebnisse

Die Schritte werden im folgenden beschrieben.

Anlegen der Kundenliste

Das erstellen der Kundenliste erfolgt über zwei Endpunkte:

1. /data_hub/monitor/add_monitor_list/v1.0/

Im ersten Schritt wird eine Liste erstellt. Der List-Identifier ist frei wählbar und dient im weiteren zur Identifikation von Listen beim hinzufügen von Einträgen, Konfigurationen und dem abholen von Ergebnissen. Desweiteren muss für jede neue Liste das Monitor-Modul mit angegeben werden.

Derzeit bieten wir folgende Monitoring-Module an:

2. /data_hub/monitor/add_monitor_entries/v1.0/

Nachdem die Liste erstellt wurde, können über den Endpunkt Einträge hinzugefügt werden. Es wird unterschieden zwischen Personen und Unternehmen. Wenn nur Personen oder Unternehmen in der zu überwachenden Liste enthalten sind, lassen Sie die jeweils andere Liste einfach leer.

Monitoring

Das Monitoring bietet die Möglichkeit der Konfiguration. Das umfasst:

• Match Rules
  • Auf die von Ihnen angelegte Kundenliste werden Match-Rules angewendet. Diese beschreiben die Felder nach denen in bekannten Insolvenz-Publikationen nach Übereinstimmungen gesucht wird.
    
    Beispiel: Ihre Kundenliste enthält den Eintrag Max Mustermann mit dem Geburtstag 1.1.1970. Sie aktivieren die Match-Rule PersonBirthday. Dann erhalten Sie ein Ergebnis, wenn diese Person (mit dem Geburtstag) in einer Insolvenzbekanntmachung erscheint. Die Regeln arbeiten mit unterschiedlicher Genauigkeit. Diese wird über den Score angegeben. Je höher der Score, desto höher ist die Genauigkeit. Eine detaillierte Liste der Match-Rules erhalten Sie über den Endpunkt get_match_rules. Auch können Sie dadurch erkennen, welche Regeln bereits aktiviert sind.
• E-Mail Empfänger und Format
  • Die Ergebnisse des Monitoring lassen sich auch als E-Mail empfangen. Mögliche E-Mail Empfänger können über den Endpunkt add_receipient_email hinzugefügt werden.
    
    Die Ausgabe-Felder lassen sich konfigurieren. Eine vollständige Liste, mit Beschreibungen, über die möglichen Felder erhalten Sie über den Endpunkt get_monitor_fields.
    
    Es stehen derzeit folgende Formate zur Auswahl: JSON, XML, XLS, CSV, PDF
• Attributsfilter
  • Um nur Ergebnisse zu bestimmten Events zu erhalten, können Sie Filter auf ein Monitor-Modul konfigurieren. Eine Referenz zu den Codes finden Sie unter Statuscodes

Abruf Ergebnisse

Die Ergebnisse sind über die beiden folgenden Endpunkte zu erhalten:

• Match-Result
  • Liefert eine Liste mit IDs zu einer Liste und Monitor-Modul zurück.
  • Um vergangene IDs abzurufen nutzen Sie die Filterung nach Datum.
  • Es werden immer nur maximal 10.000 IDs zurückgeliefert. Der Parameter starting im Request ist ein Offset. Beispiel: Ist die Anzahl der gesamten IDs 12.000, dann sind 2 Abfragen notwendig um alle IDs zu erhalten. Die erste Abfrage mit starting=0 (default), und die zweite Abfrage mit starting=10000
• Match-Detail
  • Zu einer ID aus dem Match-Result lassen sich detaillierte Informationen abfragen.

Hinweis: Nachdem eine Match-Result ID über die Match-Details abgerufen wurde, wird sie nicht erneut in den Match-Results zurückgeliefert.

Statuscodes

In den detailierten Match-Results sind Event-Codes zu entnehmen. Eine Referenz der Codes erhalten Sie hier:

Inso-Statuscodes

Biz-Statuscodes