Boniforce REST API für Unternehmensberichte
Unternehmen suchen, einen Bericht als Hintergrundjob anstoßen und das Ergebnis anschließend per Report-ID abrufen. Die aktuelle technische Referenz ist die erreichbare OpenAPI-Dokumentation.
- ✓Authentifizierung per Bearer-Token im
Authorization-Header - ✓Produktiv- und Sandbox-Schema sind technisch identisch veröffentlicht
- ✓Creditverbrauch ist je Endpoint dokumentiert
Die OpenAPI-Spezifikation ist die maßgebliche Referenz
Sie beschreibt Endpunkte, Methoden, Authentifizierung, Parameter, Antwortfelder und Creditverbrauch. Angaben auf dieser Seite sind auf diesen veröffentlichten Stand reduziert.
Vom Suchergebnis zum Unternehmensbericht
Der veröffentlichte Vertrag arbeitet asynchron mit Job-Status und anschließendem Report-Abruf.
Unternehmen suchen
GET /v1/search?query=… liefert Registerdaten und eine search_result_id.
Bericht anfordern
POST /v1/reports nutzt die search_result_id oder Registerangaben.
Status prüfen
GET /v1/jobs/{job_id}/status meldet queued, processing, completed oder failed.
Bericht abrufen
GET /v1/reports/{report_id} liefert den dokumentierten Bericht.
API-Key als Bearer-Token senden
Die OpenAPI-Spezifikation definiert HTTP-Bearer-Authentifizierung. Übergeben Sie den Schlüssel ohne Veröffentlichung im Quellcode oder Frontend.
Authorization: Bearer YOUR_API_KEY
Gleiches veröffentlichtes Schema, getrennte Hosts
Die aktuell erreichbaren OpenAPI-Dateien beider Hosts sind byteidentisch. Sandbox-Daten sind künstlich; Sandbox-Aufrufe verbrauchen laut Spezifikation keine Credits.
Testumgebung
https://sandbox.boniforce.de/v1
Test-Key-Präfix laut Dokumentation: sk_test-
- Künstliche Unternehmens- und Berichtsdaten
- Kein Creditverbrauch
- Gleiche veröffentlichten Endpunkte
Produktiv-API
https://api.boniforce.de/v1
Authentifizierung mit einem produktiven Bearer-Token.
- Endpointabhängiger Creditverbrauch
- Unternehmenssuche und Berichtserstellung
- Status- und Report-Abruf
Bestätigten Suchendpoint aufrufen
Das Beispiel zeigt ausschließlich GET /v1/search. Dieser produktive Aufruf kostet laut OpenAPI 1 API-Credit. Platzhalter ersetzen, Schlüssel serverseitig schützen und nicht direkt im Browser ausführen.
const query = encodeURIComponent('Muster GmbH');
const response = await fetch(
'https://api.boniforce.de/v1/search?query=' + query,
{
headers: {
Authorization: 'Bearer sk_live-YOUR_KEY'
}
}
);
if (!response.ok) {
throw new Error('API request failed: ' + response.status);
}
const companies = await response.json();
console.log(companies[0]?.search_result_id);Alle aktuell veröffentlichten Endpunkte in der Produktiv-Dokumentation öffnen ↗
Request und Response laut OpenAPI
Nur Felder aus der aktuellen technischen Spezifikation.
Suche
Pflichtparameter query. Antwortfelder: name, active, register_number, register_type, register_court, search_result_id und optional registered_office.
Bericht anfordern
Request: search_result_id oder Registerangaben; zusätzlich sind company_name und session_id dokumentiert.
Erstellungsantwort
report_id, job_id, Registerfelder und status.
Fertiger Bericht
Unter anderem report_id, score, score_details, credit_limit, credit_assessment_result, assessments, company, status und created_at.
Finanzdaten
GET /v1/financial_data und GET /v1/financial_data/analysis sind separat dokumentiert.
Kein öffentliches Webhook-Schema
Die aktuelle OpenAPI veröffentlicht weder einen Webhook-Endpoint noch ein Callback-Schema. Der dokumentierte asynchrone Ablauf nutzt Status-Polling.
Technisch belegter Ablauf statt unbestätigter Automationsversprechen
Eine Anwendung kann suchen, einen Bericht anfordern, den Job-Status abfragen und nach Abschluss den Bericht abrufen. Webhooks und Insolvenz-Monitoring werden hier nicht als verfügbare API-Funktion beworben, solange sie nicht in der produktiven Spezifikation veröffentlicht sind.
Je Endpoint statt „eine Anfrage = ein Credit“
Der technische Creditverbrauch unterscheidet sich vom Produkt- oder Portal-Kontingent.
GET /v1/searchGET /v1/search/advancedPOST /v1/reportsGET /v1/financial_dataGET /v1/financial_data/analysisShareholder- und Beteiligungsdaten kosten laut Spezifikation 25 API-Credits je Aktualisierung und 0 bei Auslieferung aus dem einwöchigen Cache.
Endpunkte und Schemas direkt an der technischen Quelle prüfen
Produktiv- und Sandbox-Dokumentation sind erreichbar. Für Implementierungen gilt die dort veröffentlichte Fassung.
Einmal kaufen, fertig – kein Abo, kein Vertrag
Sie kaufen ein Credits-Paket und zahlen nur für tatsächlich durchgeführte Prüfungen. Keine Grundgebühr, keine Mindestlaufzeit. Sandbox bleibt immer kostenlos.
- Zugang mit Test-Key
- Alle Endpunkte testbar
- Identisches Schema wie Live-API
- API-Anbindung kostenlos entwickeln
- Keine Echtdaten
- Prepaid – kein Abo, kein Vertrag
- Echte Live-Daten in Ihr System
- Unternehmenssuche und Report-Abruf per REST
- API-Key direkt im Dashboard erstellen
- Jederzeit Credits nachladen
- Volumenrabatt bei großen Mengen
- Optionale Jahresbudgets
- Individuelle API-Integration
- Persönlicher Ansprechpartner
- SLA & Support-Verträge
Technischer Hinweis: Paket- und Prüfungskontingente sind Angebotsangaben. Der Verbrauch einzelner API-Aufrufe ist endpointabhängig; die aktuelle OpenAPI dokumentiert 0 bis 75 API-Credits je Aufruf.
Klare Schnittstelle mit überprüfbarem Vertrag
REST/JSON, Bearer-Authentifizierung, getrennte Produktiv- und Sandbox-Hosts sowie endpointabhängige Credits sind in der erreichbaren OpenAPI veröffentlicht.
Vor der Integration den aktuellen API-Vertrag prüfen
Die Swagger-Oberflächen zeigen die derzeit veröffentlichten Endpunkte, Parameter und Antwortschemata.
Bestätigte technische Angaben
Stand der erreichbaren Produktiv-OpenAPI, Version 1.0.0.
Welche Authentifizierung nutzt die API?
HTTP-Bearer-Authentifizierung: Authorization: Bearer YOUR_API_KEY.
Wie wird ein Bericht erstellt?
Zuerst Unternehmen über GET /v1/search suchen. Anschließend POST /v1/reports mit search_result_id oder Registerangaben senden. Die Antwort enthält report_id, job_id und einen Status.
Wie kommt das Ergebnis zurück?
Den Job mit GET /v1/jobs/{job_id}/status prüfen und den fertigen Bericht über GET /v1/reports/{report_id} abrufen.
Welche Reportfelder sind dokumentiert?
Unter anderem score, score_details, credit_limit, credit_assessment_result, assessments, company und status.
Gibt es eine Sandbox?
Ja. Die OpenAPI nennt https://sandbox.boniforce.de/v1. Sie arbeitet mit künstlichen Daten, verbraucht keine Credits und nutzt Test-Keys mit dem dokumentierten Präfix sk_test-.
Unterstützt die veröffentlichte API Webhooks?
Die aktuelle OpenAPI enthält keinen Webhook-Endpoint und kein Callback-Schema. Der veröffentlichte asynchrone Ablauf verwendet Job-Status und Report-Abruf.
Wie viele API-Credits kostet ein Aufruf?
Das hängt vom Endpoint ab: Suche 1, erweiterte Suche 5, Report-Erstellung 75, Finanzdaten 25 und Finanzanalyse 50 API-Credits. Status- und bestehende Report-Abrufe sind mit 0 dokumentiert.