Einleitung in die belegFuchs API

belegFuchs stellt eine REST-API zur Verfügung, die es ermöglicht, belegFuchs in andere Anwendungen zu integrieren. So können Sie belegFuchs beispielsweise in Ihren eigenen Online-Shop einbinden oder Ihre eigenen Werkzeuge entwickeln, die auf die Daten von belegFuchs zugreifen.

OpenAPI-Spezifikation

Die OpenAPI-Spezifikation für die belegFuchs-API können Sie hier herunterladen.

Vollständigkeit der Dokumentation

Die Dokumentation der API ist noch nicht vollständig. Wir arbeiten daran, die Dokumentation so schnell wie möglich zu vervollständigen. Wenn Sie Fragen haben, können Sie uns gerne eine E-Mail an info@belegfuchs.de schreiben.

Basis-URL

Die Basis-URL für die API lautet: https://api.belegfuchs.de/v1/.

Serverzeit

Die Serverzeit ist Deutsche Zeit. Alle Zeitangaben die von der API zurückgegeben werden, sind in der Serverzeit.

Authentifizierung

Um sich mit der API zu authentifizieren, muss ein API-Key als header api-key mitgeschickt werden. Dieser kann in den Einstellungen generiert werden.

Sie können unbegrenzt viele API-Keys erstellen und diese auch wieder löschen. API-Keys haben keine Verfallszeit.

Beispiel

GET /v1/contacts/123 HTTP/1.1
Host: api.belegfuchs.de
api-key: a00e6263622149e...ca1f9bc5da51a2b32

Anfragenlimit

Die API ist auf 30 Anfragen pro 10 Sekunden begrenzt. Wenn Sie dieses Limit überschreiten, werden weitere Anfragen abgelehnt, bis das Limit wieder frei ist.