Изменения контракта

Здесь отмечаются изменения публичного API v1: новые эндпоинты и поля, новые события вебхуков, изменения кодов ошибок и лимитов. Дата — день выкладки на продакшн.

Как мы обращаемся с обратной совместимостью

Внутри версии v1 мы добавляем поля и эндпоинты, но не удаляем и не переименовываем существующие. Проектируйте разбор ответа так, чтобы незнакомое поле игнорировалось — тогда добавление поля не потребует от вас правок. Ломающие изменения выйдут отдельной версией со своим базовым адресом.

14.08.2026 — публичный API v1

Первая публичная версия контракта.

• 12 эндпоинтов: справочники (/filials, /levels, /programs, /subjects), ученики (/students, /students/{id}, /students/{studentId}/groups), группы (/groups), занятия (/lessons, /demo-lessons), оплаты (/payments), лиды (/leads). Полный перечень с параметрами — в справочнике.
• Аутентификация по ключу bb_<prefix>_<secret> в заголовке Authorization: Bearer, скоупы read и write — см. Аутентификацию.
• Лимит 120 запросов в минуту на ключ, на 429 приходит Retry-After — см. Лимиты запросов.
• Обязательный Idempotency-Key на всех операциях записи, окно повтора 24 часа.
• Вебхуки с подписью X-BigBen-Signature и пятью событиями: student.created, payment.received, lesson.completed, lead.created, group.enrolled — см. Вебхуки.

Как узнать об изменениях

Страница обновляется вместе с выкладкой изменений контракта. Отдельной рассылки пока нет; если она вам нужна, напишите на support@bigbencrm.ru — по числу запросов решим, заводить ли её.