API de AI Budget para desarrolladores
AI Budget tiene una API REST pública con autorización OAuth 2.0: «Conectar con AI Budget». Con el consentimiento del usuario, tu app puede leer y escribir sus gastos y descargar tickets y categorías. El usuario elige qué comparte y puede retirar el acceso cuando quiera.
Referencia de la APIRegistrar una appCómo lo construimos
Qué puede hacer la API hoy
- Leer, crear, modificar y eliminar gastos (
/public/v1/expenses). - Sincronizar con el feed de cambios
/public/v1/expenses/changes: lo consultas periódicamente y recibes los gastos nuevos, modificados y eliminados; las eliminaciones llegan como entradasdelete(tombstones). - Descargar las imágenes de los tickets adjuntos a los gastos.
- Leer las categorías de gastos de la cuenta.
- Cubrir varias cuentas con una conexión: el usuario marca las cuentas que comparte (personal, empresa, familia…) y cada petición indica su cuenta en la cabecera
X-Account-Id.GET /public/v1/accountslista las cuentas compartidas con su tipo. - Leer, añadir, modificar y eliminar ingresos (
/public/v1/incomes), con su propio feed de cambios; los ingresos creados por una transferencia entre cuentas son de solo lectura. - Leer presupuestos con el avance del periodo actual, y crearlos, modificarlos y eliminarlos (
/public/v1/budgets). - Leer totales para análisis (
/public/v1/analytics/summary,by-category,monthly) convertidos a la moneda de visualización del usuario. - Permisos (scopes):
expenses:read,expenses:write,receipts:read,categories:read,incomes:read,incomes:write,budgets:read,budgets:write,analytics:read.
Por ahora la API cubre gastos, tickets, categorías, ingresos, presupuestos y totales de análisis. Las metas y otros recursos podrían llegar más adelante.
Gratis y sin revisión
El acceso a la API es gratuito. Cualquier desarrollador registra su app en AI Budget por su cuenta (Ajustes → Desarrolladores), sin revisión manual ni esperas. Los límites de peticiones se aplican por conexión y por app.
La privacidad del usuario
El usuario decide qué cuentas comparte y puede desconectar tu app en cualquier momento en Ajustes → Aplicaciones conectadas (cómo funciona). Las cuentas con cifrado de extremo a extremo siguen protegidas: una cuenta con cifrado de texto solo se puede conectar en modo lectura y una cuenta con cifrado completo no se puede conectar.
Empieza en 3 pasos
- Registra una app en Ajustes → Desarrolladores: indica un nombre y una URI de redirección y obtendrás
client_idyclient_secret. - Envía al usuario a la URL de autorización
https://app.ai-budget.pl/authorizecon PKCE. El usuario inicia sesión, marca las cuentas y aprueba los permisos. - Canjea el código por un token en
POST /oauth/tokeny llama ahttps://api.ai-budget.pl/public/v1con la cabeceraAuthorization: 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"Primera integración: eKsięgowy AI
eKsięgowy AI conecta mediante la API la cuenta de empresa y la cuenta personal del usuario y las mantiene estrictamente separadas.
Documentación
Todos los endpoints (Swagger) con una guía paso a paso: