Willkommen zur InsOConnect-API
Die InsOConnect-API erlaubt es Ihnen, Insolvenzdaten und - funktionen des Insolvenz-Portals direkt in Ihre Services und Softwareanwendungen zu integrieren.
Start mit der API
Diese Dokumentation hilft Ihnen dabei, die RESTful InsOConnect API zu implementieren. Die API ist stateless, alle Anfragen werden gegen ein API-Token validiert. Das Token erhalten Sie im Rahmen der Registrierung und Freischaltung Ihres Testzugangs.
Für den Test der API haben wir ein spezielles Sandbox-Testsystem aufgebaut, gegen das Sie Ihre Implementierung zunächst durchführen können.
Fragen und Antworten
Entstehen Kosten für das Verwenden der API?
Für den Test entstehen keine Kosten. Beim Live-Einsatz der API entfallen grundsätzlich pro Abruf eine Gebühr, die davon abhängt, welcher Umfang an Daten gezogen wird. Für nähere Informationen setzen Sie sich bitte direkt mit uns in Verbindung .
In welchem Format werden API-Ergebnisse bereitgestellt?
Das Ergebnis wird im selben Format gesendet, in welchem die Anfrage erfolgt. Momentan stehen folgende Formate zur Verfügung
- JSON: JavaScript Object Notation
- XML: Extensible Markup Language
Mit welchem Protokoll kann ich die API ansprechen?
Die API wird mittels REST-Architektur über das https-Protokoll (Port 443) angesprochen. Der Client kann hierbei folgende Befehle absetzen (je nach API-Call Einschränkung):
| Befehl (http-Verb) | Beschreibung |
|---|---|
| GET | Fordert die angegebene Ressource vom Server an. |
| POST | Fügt eine neue Ressource in den Server ein. |
| PUT | Die angegebene Ressource wird angelegt. Wenn die Ressource bereits existiert, wird sie geändert. |
Gibt es eine Testumgebung?
Sobald Sie einen Zugang haben, können Sie die API in unserer Sandbox unter https://sandbox-insoconnect.insolvenz-portal.de/ testen, ohne dabei Produktivdaten zu verändern.