Техническое описание универсального приёма заявок в ClubIS. Полная спецификация в формате OpenAPI: lead.yaml.
Перед настройкой внешних форм выполните подготовку ClubIS.
| Адрес | Назначение |
|---|---|
/api/lead |
Основной приём заявок (GET или POST) |
/api/tilda |
Тот же обработчик; удобен для Tilda |
/api/marquiz |
Квизы Marquiz (JSON в теле) |
/api/gamelead |
Game Lead (POST, параметр GameLead) |
Авторизация — как у остальных методов /api/*: USER_ID + USER_HASH или token (подробнее).
Чтобы заявка обработалась, в запросе обязательно должен быть заполнен телефон или e-mail — достаточно одного из них. Если оба пустые, ClubIS вернёт ошибку и заявка не создастся.
На практике рекомендуется собирать и телефон, и e-mail, и по возможности имя с фамилией.
ClubIS сопоставляет поля анкеты по имени параметра в запросе. Регистр букв важен.
| Поле | Имя параметра | Обязательность |
|---|---|---|
| Телефон | Phone (или phone) |
Обязательно одно из двух: телефон или e-mail |
Email (или email) |
Обязательно одно из двух: телефон или e-mail | |
| Имя | Name (или title) |
Рекомендуется |
| Фамилия | Lastname |
Рекомендуется |
Произвольные имена (tel, mail, fio и т.п.) не распознаются — контакт и ФИО в анкету не попадут, хотя значения сохранятся в тексте заявки.
Все остальные параметры запроса можно называть произвольно — они попадут в описание заявки.
Source — название источника вместо «Заявка с сайта» по умолчанию.
promotion_id — код рекламного источника из справочника «Рекламные источники».
promotion — промокод из того же справочника (если не указан promotion_id).
telegram — идентификатор в Telegram (символ @ добавляется автоматически).
event_type_id — тип события из справочника «Типы событий» (переопределяет настройку в Администратор → Интеграции).
goal_id — цель сделки: 0 — не указано, 1 — продажа контракта, 2 — продажа услуги.
user_id — менеджер, на которого назначается заявка.
status_id — состояние заявки: 1 создана, 2 в работе, 3 состоялась, 4 не состоялась.
price, cost — сумма и себестоимость сделки.
visit, roistat, roistat_url — идентификатор визита Roistat.
utm_source, utm_medium, utm_campaign, utm_term, utm_content — UTM-метки.
tranid, formid — служебные поля Tilda (номер заявки и формы).
Различайте USER_ID (авторизация и «Создал» в истории) и user_id (назначение менеджера на сделку).
После обработки заявки web-service возвращает код 200 OK и JSON в теле ответа (заголовок Content-Type: text/plain).
Успешная обработка:
{"status":"ok","order_id":"12345","profile_id":"67890"}
| Поле | Описание |
|---|---|
status |
ok — заявка принята |
order_id |
Номер сделки во вкладке Лиды модуля Менеджер |
profile_id |
Номер анкеты клиента в ClubIS |
Поле profile_id позволяет внешней системе сразу связать заявку с анкетой.
Ошибка — status равен error, текст в errorString:
Order not created).curl -X POST 'https://test.club-is.ru/api/lead?USER_ID=30&USER_HASH=f77d565e02169dad60bca51ea19bd53cf1a041d6&Source=website&Phone=9996663322&Name=Ivan&Email=a@b.com'
Пример ответа:
{"status":"ok","order_id":"12345","profile_id":"67890"}
Пошаговые инструкции — в разделе источники заявок на обзорной странице Lead API.