Skip to main content

​
Übersicht

Die Business OS API bietet Zugang zu DATEV- und Banking-Schnittstellen über eine einheitliche REST API. Alle Endpoints sind unter https://api.business-os.de erreichbar.

​
Authentifizierung

Alle API Endpoints erfordern einen API Key im x-api-key Header:
Erstelle deinen API Key im Dashboard unter API Keys. Mehr dazu im Authentication Guide.

​
Credits

Viele — aber nicht alle — API-Aufrufe verbrauchen Credits; die genauen Kosten sind bei jedem Endpoint angegeben (inklusive der kostenlosen Cache-Reads). V2-Endpoints handeln die Credit-Reservierung und -Bestätigung automatisch. Das Credit-System nutzt ein 2-Phase-Commit Pattern:
  1. Reserve — Credits werden vor dem API-Aufruf reserviert
  2. Confirm — Nach erfolgreichem Aufruf werden die Credits abgebucht
  3. Expire — Bei Fehlern verfällt die Reservierung automatisch

​
Rate Limits

Die API begrenzt die Anzahl der Anfragen pro Zeitfenster, um Missbrauch zu verhindern und eine stabile Performance zu gewährleisten. Bei Überschreitung erhältst du einen 429 Too Many Requests Response. Die Standard-Headers RateLimit-Limit, RateLimit-Remaining und RateLimit-Reset werden in jeder Response mitgeliefert.
Plane deine Integrationen so, dass sie die Rate Limits nicht überschreiten. Für Make.com oder n8n Szenarien mit vielen Organisationen empfehlen wir, Requests zeitlich zu verteilen.

​
API-Version

Diese Dokumentation beschreibt die V2-REST-API unter dem Pfad-Präfix /v2/. Requests laufen serverseitig über unser Backend zu den jeweiligen Schnittstellenpartnern; Credits werden wie oben beschrieben automatisch reserviert und bestätigt.