AI Budget API für Entwickler

AI Budget hat eine öffentliche REST-API mit OAuth-2.0-Autorisierung – „Mit AI Budget verbinden“. Mit Zustimmung der Nutzer kann Ihre App deren Ausgaben lesen und schreiben sowie Kassenbons und Kategorien abrufen. Die Nutzer entscheiden selbst, was sie teilen, und können den Zugriff jederzeit widerrufen.

API-Referenz App registrieren Wie wir es gebaut haben

Was die API heute kann

Ausgaben lesen, anlegen, ändern und löschen (/public/v1/expenses).
Über den Änderungs-Feed /public/v1/expenses/changes synchronisieren: regelmäßig abfragen und neue, geänderte und gelöschte Ausgaben erhalten – Löschungen kommen als delete-Einträge (Tombstones).
Die Kassenbon-Bilder herunterladen, die an Ausgaben hängen.
Die Ausgabenkategorien des Kontos lesen.
Mehrere Konten in einer Verbindung: Die Nutzer wählen die geteilten Konten (privat, geschäftlich, Familie …), und jede Anfrage nennt ihr Konto im Header X-Account-Id. GET /public/v1/accounts listet die geteilten Konten mit ihrem Typ.
Einnahmen lesen, hinzufügen, ändern und löschen (/public/v1/incomes), mit eigenem Änderungs-Feed; Einnahmen aus Überweisungen zwischen Konten sind schreibgeschützt.
Budgets mit dem Fortschritt des aktuellen Zeitraums lesen sowie anlegen, ändern und löschen (/public/v1/budgets).
Summen für Auswertungen lesen (/public/v1/analytics/summary, by-category, monthly), umgerechnet in die Anzeigewährung des Nutzers.
Berechtigungen (Scopes): expenses:read, expenses:write, receipts:read, categories:read, incomes:read, incomes:write, budgets:read, budgets:write, analytics:read.

Derzeit umfasst die API Ausgaben, Kassenbons, Kategorien, Einnahmen, Budgets und Auswertungssummen. Ziele und weitere Ressourcen können später dazukommen.

Kostenlos und ohne Prüfung

Der API-Zugang ist kostenlos. Entwickler registrieren ihre App selbst in AI Budget (Einstellungen → Entwickler) – ohne manuelle Prüfung, ohne Wartezeit. Ratenlimits gelten pro Verbindung und pro App.

Privatsphäre der Nutzer

Die Nutzer entscheiden, welche Konten sie teilen, und können Ihre App jederzeit unter Einstellungen → Verbundene Apps trennen (so funktioniert es). Ende-zu-Ende-verschlüsselte Konten bleiben geschützt: Ein Konto mit Textverschlüsselung lässt sich nur lesend verbinden, ein vollständig verschlüsseltes Konto gar nicht.

In 3 Schritten starten

App registrieren unter Einstellungen → Entwickler: Namen und Redirect-URI angeben, und Sie erhalten client_id und client_secret.
Nutzer weiterleiten zur Autorisierungs-URL https://app.ai-budget.pl/authorize mit PKCE. Dort melden sie sich an, wählen die Konten und bestätigen die Berechtigungen.
Code eintauschen gegen ein Token unter POST /oauth/token und https://api.ai-budget.pl/public/v1 mit dem Header Authorization: Bearer … aufrufen.

# 1. Send the user to the consent page (PKCE S256)
https://app.ai-budget.pl/authorize?response_type=code&client_id=aba_ci_...
  &redirect_uri=https%3A%2F%2Fexample.com%2Fcallback
  &scope=expenses%3Aread+categories%3Aread&state=...
  &code_challenge=...&code_challenge_method=S256

# 2. Exchange the code for tokens
curl -X POST https://api.ai-budget.pl/oauth/token \
  -u "$CLIENT_ID:$CLIENT_SECRET" \
  -d grant_type=authorization_code -d code="$CODE" \
  -d redirect_uri=https://example.com/callback -d code_verifier="$CODE_VERIFIER"

# 3. Call the API for one of the connected accounts
curl https://api.ai-budget.pl/public/v1/accounts -H "Authorization: Bearer $ACCESS_TOKEN"
curl https://api.ai-budget.pl/public/v1/expenses -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "X-Account-Id: $ACCOUNT_ID"

Erste Integration: eKsięgowy AI

eKsięgowy AI verbindet über die API das Geschäfts- und das Privatkonto eines Nutzers und hält beide strikt getrennt.

Dokumentation

Alle Endpunkte (Swagger) mit einer Schritt-für-Schritt-Anleitung:

API-Referenz App registrieren Wie wir es gebaut haben

English · Polski · Русский · OpenAPI-Schema (JSON)