Внешний API: основы

Как работать с External API Budgeter: базовый URL, аутентификация, получение API ключа, лимиты и формат ответа.

Download Postman collection (External API)

All methods (accounts, etc.) without key — add your key in collection variables.

External API Budgeter — серверный API для интеграций. Доступ по API ключу (заголовок X-Api-Key).

Базовый URL

  • Production: https://api-external.budgeter.online

Где получить API ключ

В веб-приложении: Настройки → Интеграции → API ключи. Создайте ключ и скопируйте его сразу — полный ключ показывается один раз. Храните в секрете.

Аутентификация

Передавайте ключ в заголовке:

X-Api-Key: <ваш_api_ключ>

Формат запроса

Все методы — POST. Тело — JSON:

{
  "meta": { "requestId": "опционально", "locale": "опционально" },
  "data": { ... }
}

Формат ответа (успех)

В ответе: success: true, data, meta (requestId, serverTime, executionTimeMs, project, rateLimit).

Коды ошибок

INVALID_API_KEY / API_KEY_REVOKED (401), FORBIDDEN_SCOPE / API_KEY_TEMPORARILY_BLOCKED (403), RATE_LIMIT_EXCEEDED (429, заголовок Retry-After), VALIDATION_ERROR (400), RESOURCE_NOT_FOUND (404), INTERNAL_ERROR (500).

Лимиты (MVP)

  • 120 запросов/минуту

  • 3000/час, 30000/день, 600000/месяц

  • Изменяющие операции (create/update/delete): 60/минуту

При превышении: HTTP 429 и заголовок Retry-After (секунды).

См. также

API: Счета — список, получение, создание, обновление, удаление счетов.

Оцените статью — нам важна ваша обратная связь.

0 (0 оценок)