API do AI Budget para desenvolvedores
O AI Budget tem uma API REST pública com autorização OAuth 2.0 – “Conectar ao AI Budget”. Com o consentimento do usuário, seu app pode ler e gravar as despesas dele e baixar recibos e categorias. O usuário escolhe o que compartilhar e pode revogar o acesso a qualquer momento.
Referência da APIRegistrar um appComo construímos
O que a API já faz hoje
- Ler, criar, alterar e excluir despesas (
/public/v1/expenses). - Sincronizar pelo feed de alterações
/public/v1/expenses/changes: consulte-o periodicamente e receba despesas novas, alteradas e excluídas – as exclusões chegam como entradasdelete(tombstones). - Baixar as imagens dos recibos anexados às despesas.
- Ler as categorias de despesa da conta.
- Atender várias contas com uma só conexão: o usuário marca as contas que compartilha (pessoal, empresa, família…) e cada requisição indica a conta no cabeçalho
X-Account-Id.GET /public/v1/accountsretorna as contas compartilhadas com o tipo de cada uma. - Ler, adicionar, alterar e excluir receitas (
/public/v1/incomes), com um feed de alterações próprio; receitas criadas por uma transferência entre contas são somente leitura. - Ler orçamentos com o progresso do período atual, além de criá-los, alterá-los e excluí-los (
/public/v1/budgets). - Ler totais de análise (
/public/v1/analytics/summary,by-category,monthly) convertidos para a moeda de exibição do usuário. - Permissões (scopes):
expenses:read,expenses:write,receipts:read,categories:read,incomes:read,incomes:write,budgets:read,budgets:write,analytics:read.
Por enquanto, a API cobre despesas, recibos, categorias, receitas, orçamentos e totais de análise. Metas e outros recursos podem vir depois.
Gratuita e sem revisão
O acesso à API é gratuito. Qualquer desenvolvedor registra o próprio app no AI Budget (Configurações → Desenvolvedores) – sem revisão manual e sem espera. Os limites de requisições valem por conexão e por app.
A privacidade do usuário
O usuário decide quais contas compartilhar e pode desconectar seu app a qualquer momento em Configurações → Apps conectados (como funciona). Contas com criptografia de ponta a ponta continuam protegidas: uma conta com criptografia de texto só pode ser conectada como somente leitura, e uma conta totalmente criptografada não pode ser conectada.
Comece em 3 passos
- Registre um app em Configurações → Desenvolvedores: informe um nome e um redirect URI e receba um
client_ide umclient_secret. - Envie o usuário para a URL de autorização
https://app.ai-budget.pl/authorizecom PKCE. O usuário entra, marca as contas e aprova as permissões. - Troque o código por um token em
POST /oauth/tokene chamehttps://api.ai-budget.pl/public/v1com o cabeçalhoAuthorization: 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"Primeira integração: eKsięgowy AI
eKsięgowy AI conecta pela API a conta da empresa e a conta pessoal de um usuário e mantém as duas estritamente separadas.
Documentação
Todos os endpoints (Swagger), com um guia passo a passo: