Schnellstart

1. Schlüssel anlegenLink zu diesem Abschnitt kopieren

Das geht nur als Inhaber der Firma und mit einem gültigen bezahlten Tarif oder einer Freischaltung durch bimetrics.

1. Öffne in der App Einstellungen › API (app.bimetrics.de/settings/api-keys).
2. Wähle Schlüssel erstellen und vergib einen Namen, zum Beispiel den Namen deiner Anwendung.
3. Wähle die Berechtigungen: Daten lesen (read) und bei Bedarf Belege hochladen (upload).
4. Wähle die Gültigkeit (30, 90 oder 365 Tage) und bestätige mit deinem aktuellen Passwort.

Der Schlüssel beginnt mit bm_ und wird nur einmal angezeigt. Alle Inhaber der Firma erhalten eine E-Mail über den neuen Zugang.

2. Ersten Aufruf sendenLink zu diesem Abschnitt kopieren

Speichere den Schlüssel als Umgebungsvariable und frage Tarif und Kontingent ab. Der Aufruf ändert nichts und eignet sich als Test.

export BIMETRICS_API_KEY='bm_…'

curl --fail-with-body https://app.bimetrics.de/api/entitlement/ \
  -H "Authorization: Bearer $BIMETRICS_API_KEY"

Die Antwort enthält unter anderem den Tarif und die Nutzung im laufenden Zeitraum (gekürzt):

{
  "active": true,
  "tier": "team",
  "period": { "start": "2026-09-01T00:00:00Z", "end": "2026-10-01T00:00:00Z" },
  "usage": { "documentsPeriod": 42 }
}

Die Firma ergibt sich aus dem Schlüssel. Eine Firmen-ID schickst du nie mit.

3. Daten lesenLink zu diesem Abschnitt kopieren

Belege, Kontakte, Bankkonten, Umsätze und Buchungen suchst du mit einer Filteranfrage. Dieses Beispiel liefert die ersten 20 Belege ohne weitere Bedingung:

curl --fail-with-body https://app.bimetrics.de/api/document/filter \
  -H "Authorization: Bearer $BIMETRICS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind": "and", "children": [], "limit": 20}'

Die Antwort hat die Form { "total": …, "limit": …, "offset": …, "items": [ … ] }. Wie du filterst, sortierst und blätterst, steht unter Filtern und Paginieren.

Wie es weitergehtLink zu diesem Abschnitt kopieren

• Authentifizierung und Scopes: Header, Berechtigungen, Laufzeit und Widerruf.
• Fehler und Limits: was bei 4xx, 5xx und 429 zu tun ist.
• Beleg-Upload: Belege ohne Doppelungen einreichen.
• API-Referenz: alle Endpunkte, mit Playground zum Ausprobieren.