Zum Inhalt springen

REST-API und API-Zugänge

Wie Sie in BetriebsOffice einen API-Zugang mit passenden Berechtigungen anlegen, den Schlüssel sicher verwahren und Zugänge wieder widerrufen.

Kapitel: Integrationen und Schnittstellen Aktualisiert: 3 Min. Lesezeit

BetriebsOffice hat eine REST-API, über die andere Programme Daten lesen und schreiben können: Ihre Buchhaltung, ein Auswertungswerkzeug, Zapier, Make oder eine eigene Anbindung. Die API steht in jedem Tarif offen. Was ein Programm darf, legen Sie mit einem API-Zugang fest. Zugänge anlegen dürfen Personen mit dem Recht „Stammdaten des Betriebs bearbeiten“, in der Regel die Inhaberin oder der Inhaber.

Schritt für Schritt: Zugang anlegen

  1. Öffnen Sie Einstellungen › API-Zugänge.
  2. Klicken Sie auf Zugang anlegen.
  3. Wählen Sie unter Vorlage, wofür der Zugang gedacht ist: Zapier, Make, Buchhaltung, Auswertungen oder Eigene Anbindung. Die Vorlage setzt empfohlene Berechtigungen und eine Grenze, beides lässt sich anpassen.
  4. Geben Sie eine Bezeichnung ein, an der Sie den Zugang später wiedererkennen, etwa „Zapier Buchhaltung“.
  5. Prüfen Sie die Berechtigungen (siehe unten).
  6. Setzen Sie bei Bedarf unter Ablauf und Grenze ein Datum für den Ablauf und das Rate Limit je Minute. Ohne Angabe gilt der Zugang unbefristet mit der Grenze der Vorlage.
  7. Klicken Sie auf Anlegen.
  8. Kopieren Sie im Fenster Neuer API-Schlüssel den Schlüssel mit Kopieren und hinterlegen Sie ihn im anderen Programm.

Der Schlüssel wird nur dieses eine Mal angezeigt. Haben Sie ihn verloren, widerrufen Sie den Zugang und legen einen neuen an.

Berechtigungen (Scopes)

Berechtigungen geben Sie kommagetrennt an. read:<modul> erlaubt Lesen, write:<modul> Schreiben, zum Beispiel read:customers, write:quotes. Geben Sie einem Zugang nur, was er wirklich braucht. Eine Auswertung braucht etwa nur Leserechte.

Welche Berechtigungen es gibt, zeigt Einstellungen › Entwickler und Webhooks im Abschnitt Scopes für API-Tokens. Berechtigungen für Bereiche, die Ihr Betrieb nicht gebucht hat, sind dort gesondert aufgeführt. Sie wirken erst nach der Buchung.

Zugänge im Blick behalten

Die Liste zeigt je Zugang die Bezeichnung, den Anfang des Schlüssels, die Vorlage, die Berechtigungen, das Rate Limit, den Ablauf und wann er Zuletzt verwendet wurde. Ein Zugang, der lange nicht genutzt wurde, wird wahrscheinlich nicht mehr gebraucht.

Mit Widerrufen sperren Sie einen Zugang sofort. Integrationen mit diesem Schlüssel verlieren den Zugriff. Widerrufene Zugänge bleiben durchgestrichen mit Datum in der Liste.

Technische Angaben für Entwickler

Unter Einstellungen › Entwickler und Webhooks finden Entwicklerinnen und Entwickler im Abschnitt REST-API die Basisadresse, die Version, das Rate Limit, die OpenAPI-Beschreibung und die Dokumentation. Unter Beispiele stehen Aufrufe mit curl und JavaScript.

  • Der Schlüssel wird als Kopfzeile Authorization: Bearer bo_… gesendet.
  • Das Rate Limit gilt je Zugang, zwischen 10 und 6.000 Anfragen je Minute. Darüber antwortet die API mit dem Status 429.
  • Die Beschreibung der API ist öffentlich und versioniert. Neue Hauptversionen laufen lange parallel zur alten.

Tipps

  • Für Zapier und Make gibt es fertige App-Beschreibungen. Wie Sie sie einbinden, lesen Sie unter Weitere Integrationen.
  • Soll ein anderes System sofort von Ereignissen erfahren, statt regelmäßig nachzufragen, nutzen Sie Webhooks.
  • KI-Assistenten wie Claude oder ChatGPT verbinden Sie am besten ohne festen Schlüssel über KI-Assistenten.
  • Legen Sie für jedes Programm einen eigenen Zugang an. Dann können Sie einen einzelnen widerrufen, ohne die anderen zu stören.

Weiterlesen

Kostenlos testen

Bereit für den Wechsel?

Testen Sie BetriebsOffice 30 Tage mit Ihren eigenen Daten oder lassen Sie sich in 30 Minuten zeigen, wie Ihr Betrieb damit läuft.