Налаштування AI-агента

Передайте Claude Code, Codex або OpenClaw одну адресу підключення. Агент прочитає опис API, підтвердить 8-значний код, збереже свій довготривалий ApiKey і почне працювати з вашим робочим простором.

Посилання, яке треба передати агенту

Передайте цю точну адресу:

https://api.expense-budget-tracker.com/v1/

Це канонічна публічна точка входу для AI-агентів. Вона пояснює агенту, як розпочати автентифікацію, які ендпоїнти викликати далі, який спосіб автентифікації використовувати після входу і де знайти опубліковану специфікацію API.

Що має зробити користувач

  1. Відкрийте Claude Code, Codex, OpenClaw або іншого агента, який уміє виконувати HTTP-запити.
  2. Скажіть агенту підключитися до Expense Budget Tracker через https://api.expense-budget-tracker.com/v1/.
  3. Коли агент попросить адресу електронної пошти, вкажіть email, який ви використовуєте для Expense Budget Tracker.
  4. Перевірте пошту й знайдіть 8-значний код.
  5. Передайте цей код агенту.
  6. Дозвольте агенту зберегти отриманий ApiKey поза пам'яттю чату, а потім перейти до імпорту, запиту або роботи з бюджетом.

Під час входу не потрібно вручну копіювати й вставляти ключ. Після перевірки коду з листа агент сам налаштовує підключення.

Що робить агент

Повна послідовність виглядає так:

  1. GET https://api.expense-budget-tracker.com/v1/
  2. Прочитати початкову відповідь і виконувати дії, які вона повертає, замість того щоб покладатися на жорстко зашиті наступні кроки
  3. Надіслати POST з email користувача на повернений bootstrapUrl
  4. Отримати otpSessionToken і дію verify_code
  5. Запитати в користувача 8-значний код із листа
  6. Надіслати POST з code, otpSessionToken і міткою підключення label на https://auth.expense-budget-tracker.com/api/agent/verify-code
  7. Отримати новий ApiKey
  8. Зберегти цей ключ поза пам'яттю чату, бажано як EXPENSE_BUDGET_TRACKER_API_KEY
  9. Виконати GET https://api.expense-budget-tracker.com/v1/me з Authorization: ApiKey <key>
  10. Виконати GET https://api.expense-budget-tracker.com/v1/workspaces
  11. За потреби створити робочий простір через POST /v1/workspaces
  12. Зберегти робочий простір за замовчуванням через POST /v1/workspaces/{workspaceId}/select
  13. Переглянути дозволені зв'язки через GET https://api.expense-budget-tracker.com/v1/schema
  14. Виконувати SQL через POST https://api.expense-budget-tracker.com/v1/sql

Вибір робочого простору задається явно, але не скидається після кожного запиту. Після POST /v1/workspaces/{workspaceId}/select вибраний робочий простір зберігається для цього API-ключа, тому в наступних викликах /v1/sql можна не передавати X-Workspace-Id. За потреби ви все одно можете надіслати X-Workspace-Id, щоб тимчасово перевизначити збережений робочий простір для конкретного запиту.

Якщо в користувача є рівно один робочий простір, а для ключа ще не збережено вибір, бекенд автоматично збереже й використає саме цей робочий простір.

Що агент має зберігати

Ключ, який повертає verify-code, є довготривалим. Не покладайтеся лише на пам'ять чату.

  • Збережіть його в локальному файлі .env як EXPENSE_BUDGET_TRACKER_API_KEY='<PASTE_KEY_HERE>', якщо користувач дозволяє запис у файли
  • Інакше експортуйте його в поточній оболонці як EXPENSE_BUDGET_TRACKER_API_KEY='<PASTE_KEY_HERE>' і попросіть користувача зберегти його в надійному постійному місці

Автентифіковані запити використовують:

  • Authorization: ApiKey <key>
  • X-Workspace-Id: <workspaceId> лише якщо ви хочете перевизначити збережений робочий простір або якщо його ще не збережено

Якщо ви AI-агент

Почніть із:

curl https://api.expense-budget-tracker.com/v1/

Потім виконуйте дії, які поверне сервер. Не припускайте наперед жорстко задані наступні кроки, якщо початкова відповідь уже містить потрібні інструкції.

Після verify-code безпечно збережіть отриманий ApiKey. Потім завантажте:

  • /v1/me для контексту облікового запису
  • /v1/workspaces для списку доступних робочих просторів
  • /v1/schema для переліку дозволених SQL-зв'язків і стовпців
  • /v1/openapi.json або /v1/swagger.json для опублікованої машинозчитуваної специфікації API

Приклади запитів для людей

Claude Code

Підключися до Expense Budget Tracker через https://api.expense-budget-tracker.com/v1/.
Коли буде потрібно, використай email мого облікового запису, попроси мене ввести 8-значний код, збережи отриманий ApiKey поза пам'яттю чату, а потім імпортуй мою останню банківську виписку з ~/Downloads.

Codex

Використай https://api.expense-budget-tracker.com/v1/, щоб підключитися до мого облікового запису Expense Budget Tracker.
Запитай мій email, дочекайся коду з листа, збережи ключ, переглянь /schema, а потім покажи мої останні транзакції.

OpenClaw

Підключися до Expense Budget Tracker через https://api.expense-budget-tracker.com/v1/.
Після входу покажи список моїх робочих просторів, збережи один із них як робочий простір за замовчуванням для цього ключа й імпортуй новий CSV-файл, який я завантажив.

Що можна робити після налаштування

  • Імпортувати банківські виписки або вивантаження з картки
  • Категоризувати транзакції за наявними категоріями
  • Звіряти баланси рахунків із даними банку
  • Аналізувати витрати за категорією, періодом, продавцем або рахунком
  • Оновлювати рядки бюджету на наступний місяць

Докладніше про низькорівневі ендпоїнти й автентифікацію дивіться в Довіднику API.