Словарь терминов: интерфейс CRM и API

Названия ресурсов и методов публичного API не всегда дословно совпадают с тем, как соответствующий раздел называется в интерфейсе BigBen CRM. Если вы получили задачу вида «нам нужно принимать заявки с сайта» и не находите на этой витрине слово «заявки» — используйте таблицу ниже, чтобы перейти от названия раздела CRM к нужной сущности API.

Раздел в интерфейсе CRM	Сущность API	Метод	Событие вебхука
«Заявки»	lead	POST /leads	lead.created
«Пробные уроки» (в аналитике встречается и «Демо-уроки»)	demo-lesson	POST /demo-lessons	—

Остальные разделы интерфейса называются так же, как соответствующие ресурсы API, — «Филиалы» ↔ filials, «Группы» ↔ groups, «Ученики» ↔ students, «Платежи» ↔ payments, «Уроки» ↔ lessons, «Справочники» ↔ subjects/programs/levels — и в этой таблице не перечислены.

Подробнее о заявках — в сценарии «Приём лида с сайта школы» на странице «Сценарии использования» и в каталоге событий на странице «Вебхуки».