REST API v2.4.0

API автоматизации бизнеса

Программный интерфейс для создания сценариев автоматизации, управления задачами, интеграции с внешними сервисами и получения аналитических отчётов.

Base URL: https://api.businessimprovement.ru/v2
Формат: application/json

Введение

BusinessImprovement API предоставляет полный набор инструментов для программной автоматизации бизнес-процессов. Вы можете создавать сложные сценарии автоматизации, управлять задачами сотрудников, интегрироваться с CRM-системами, мессенджерами и платёжными шлюзами, а также получать детальные отчёты по эффективности.

Высокая скорость

Среднее время ответа < 120 мс. Обработка до 10 000 запросов в минуту.

Безопасность

OAuth 2.0, API-ключи с тонкой настройкой прав и IP-whitelist.

Вебхуки

Мгновенные уведомления о событиях. Надёжная доставка с retry-политикой.

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

Все запросы к API должны включать заголовок Authorization с Bearer-токеном. Получить ключ можно в личном кабинете.

POST /auth/token
Требует API-ключ
// Запрос на получение Bearer-токена
curl -X POST https://api.businessimprovement.ru/v2/auth/token \
  -H "Content-Type: application/json" \
  -H "X-API-Key: bi_live_8f3a2c1d4e5b6f7a8b9c0d1e2f3a4b5c" \
  -d '{
    "grant_type": "client_credentials",
    "scope": "workflows:read tasks:write reports:read"
  }'
Ответ 200 OK
{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "Bearer",
  "expires_in": 3600,
  "scope": "workflows:read tasks:write reports:read"
}

Обработка ошибок

API возвращает стандартные HTTP-коды состояния. Тело ошибки содержит машиночитаемый код и описание.

Код Значение Описание
400Bad RequestНекорректный запрос
401UnauthorizedНедействительный токен
403ForbiddenНедостаточно прав
404Not FoundРесурс не найден
429Rate LimitПревышен лимит запросов
500Internal ErrorВнутренняя ошибка сервера

Сценарии автоматизации

Сценарии (workflows) — это цепочки автоматических действий, запускаемые по триггеру: новое письмо, заполнение формы, вебхук, расписание.

GET /workflows
POST /workflows
POST /workflows/{id}/execute

Управление задачами

API задач позволяет создавать, назначать и отслеживать выполнение задач сотрудниками в рамках автоматизированных процессов.

GET /tasks
PUT /tasks/{id}/complete

Интеграции

Подключайте внешние сервисы: CRM (amoCRM, Bitrix24), мессенджеры (Telegram, WhatsApp), платёжные системы, 1С, Google Sheets.

GET /integrations

Отчёты

Генерируйте отчёты по эффективности автоматизации: выполненные сценарии, сэкономленное время, конверсия, статистика по задачам.

POST /reports/generate

Вебхуки

Настраивайте вебхуки для получения мгновенных уведомлений о событиях в реальном времени. Подпись запросов — HMAC-SHA256.

POST /webhooks
DELETE /webhooks/{id}

Лимиты запросов

1 000

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

Тариф «Стандарт»

10 000

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

Тариф «Бизнес»

индивидуально

Тариф «Enterprise»