Документация

Административный API

Автоматизируйте betool из ваших систем — создание pipeline, история выполнений, управление организацией.

Административный API

Вся административная часть betool доступна через аутентифицированный REST API. Это канал для автоматизации: провижининг организаций на лету, синхронизация pipeline из вашего Git-репозитория, кастомные дашборды, интеграция с ITSM.

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

Bearer-токен, выпускаемый в разделе Администрирование → Токены вашей организации.

curl -H "Authorization: Bearer $BETOOL_TOKEN" \
  https://platform.betool.ai/api/admin/me

Токен ограничен областью одной организации и одной роли. Роль определяет, что вы можете читать и записывать.

Пагинация и фильтрация

Все эндпоинты списков следуют единому соглашению:

  • ?limit=50 (по умолчанию 25, максимум 200)
  • ?offset=0
  • ?sort=-created_at (префикс - для убывающего порядка)
  • Произвольные фильтры: ?status=ok&created_after=2026-05-01

Ответ включает заголовок X-Total-Count для пагинации без курсора.

Ключевые эндпоинты

ЭндпоинтОписание
GET /api/admin/meИдентификация, текущая организация, роль
GET /api/admin/pipelinesСписок pipeline
POST /api/admin/pipelinesСоздать pipeline
PATCH /api/admin/pipelines/{id}Обновить pipeline
GET /api/admin/pipelines/{id}/executionsИстория выполнений
GET /api/admin/billing/balanceБаланс кредитов
POST /api/admin/billing/topupРучное пополнение
GET /api/admin/me/content-readsЖурнал аудита межтенантного доступа

Полная документация OpenAPI доступна по адресу /api/admin/openapi.json после аутентификации.

Идемпотентность

POST-эндпоинты принимают заголовок Idempotency-Key. Если вы повторно отправляете тот же запрос с тем же ключом, вы получаете тот же ответ — это полезно для стратегий повторных попыток на стороне клиента.

Исходящие webhook

Настройте betool на уведомление вас о ключевых событиях (неудачное выполнение, низкий баланс, новый пользователь). См. Исходящие webhook.

Ограничение частоты запросов

По умолчанию:

  • 1 000 запросов в минуту на токен
  • 100 запросов в минуту для затратных эндпоинтов записи (создание pipeline, пакетный импорт)

В тарифе Enterprise лимиты настраиваются.

SDK

Официальных SDK (пока) нет. API достаточно прост, чтобы использовать его из любого языка с HTTP-клиентом.

Если вы напишете SDK для своей организации, сообщите нам — мы включим его в список.