API AI Budget для распрацоўшчыкаў

У AI Budget ёсць публічнае REST API з аўтарызацыяй OAuth 2.0 – «Падключыць AI Budget». Са згоды карыстальніка ваша праграма можа чытаць і запісваць яго выдаткі, спампоўваць чэкі і катэгорыі. Карыстальнік сам выбірае, чым дзяліцца, і можа ў любы момант адклікаць доступ.

Дакументацыя APIЗарэгістраваць праграмуЯк мы гэта зрабілі

Што API ўмее ўжо цяпер

• Чытаць, ствараць, змяняць і выдаляць выдаткі (/public/v1/expenses).
• Сінхранізавацца праз стужку змяненняў /public/v1/expenses/changes: вы перыядычна апытваеце яе і атрымліваеце новыя, змененыя і выдаленыя выдаткі – выдаленні прыходзяць запісамі delete (tombstone).
• Спампоўваць фота чэкаў, прымацаваных да выдаткаў.
• Чытаць катэгорыі выдаткаў рахунку.
• Працаваць з некалькімі рахункамі ў адным падключэнні: карыстальнік адзначае рахункі, якімі дзеліцца (асабісты, бізнес, сямейны…), а кожны запыт паказвае рахунак у загалоўку X-Account-Id. GET /public/v1/accounts вяртае падключаныя рахункі з іх тыпам.
• Чытаць, дадаваць, змяняць і выдаляць даходы (/public/v1/incomes) — са сваёй стужкай змен; даходы, створаныя пераводам паміж рахункамі, даступныя толькі для чытання.
• Чытаць бюджэты з прагрэсам бягучага перыяду, а таксама ствараць, змяняць і выдаляць іх (/public/v1/budgets).
• Чытаць вынікі для аналітыкі (/public/v1/analytics/summary, by-category, monthly), пераразлічаныя ў валюту адлюстравання карыстальніка.
• Правы доступу (scopes): expenses:read, expenses:write, receipts:read, categories:read, incomes:read, incomes:write, budgets:read, budgets:write, analytics:read.

Пакуль API ахоплівае выдаткі, чэкі, катэгорыі, даходы, бюджэты і вынікі для аналітыкі. Мэты і іншыя рэсурсы могуць з’явіцца пазней.

Бясплатна і без праверкі

Доступ да API бясплатны. Любы распрацоўшчык сам рэгіструе праграму ў AI Budget (Налады → Распрацоўшчыкам) – без ручной праверкі і чакання. Ліміты запытаў лічацца асобна для кожнага падключэння і для кожнай праграмы.

Прыватнасць карыстальніка

Карыстальнік сам вырашае, якімі рахункамі дзяліцца, і ў любы момант можа адключыць праграму ў Налады → Падключаныя праграмы (як гэта працуе). Рахункі са скразным шыфраваннем застаюцца абароненымі: рахунак з шыфраваннем тэксту падключаецца толькі для чытання, а цалкам зашыфраваны рахунак падключыць нельга.

Старт за 3 крокі

1. Зарэгіструйце праграму ў Налады → Распрацоўшчыкам: пакажыце назву і адрас перанакіравання (redirect URI) – вы атрымаеце client_id і client_secret.
2. Адпраўце карыстальніка на адрас аўтарызацыі https://app.ai-budget.pl/authorize з PKCE. Карыстальнік уваходзіць, адзначае рахункі і пацвярджае правы.
3. Абмяняйце код на токен у POST /oauth/token і выклікайце https://api.ai-budget.pl/public/v1 з загалоўкам Authorization: Bearer ….

# 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"

Першая інтэграцыя: eKsięgowy AI

eKsięgowy AI падключае праз API бізнес-рахунак і асабісты рахунак карыстальніка і строга трымае іх асобна.

Дакументацыя

Апісанне ўсіх эндпойнтаў (Swagger) і пакрокавае кіраўніцтва:

Дакументацыя APIЗарэгістраваць праграмуЯк мы гэта зрабілі

English · Polski · Русский · Схема OpenAPI (JSON)