- Главная
- Интеграции
- Формы сайта
Формы сайта и API
Отправляйте заявки с форм любого сайта в CRM одним HTTP-запросом: ключ API с областью создания заявок, метки рекламы, защита от дублей.
Как подключить
Заявка попадает в CRM без почты и таблиц
Подойдёт любая форма, квиз или калькулятор, у которых есть обработчик на сервере.
Выпустите ключ
«Настройки компании», страница «API-ключи», кнопка «Выпустить ключ». Ключ работает с правами выбранного сотрудника, хватит области «Создание». Значение показывается один раз.
Сохраните ключ на сервере
В настройках сервера, а не в коде страницы и не в JavaScript.
Добавьте запрос
В обработчике формы отправьте данные на POST /api/v1/leads. Заявка сразу появится в списке.
WordPress и 1С-Битрикс. Для форм Contact Form 7 и веб-форм Битрикса программировать ничего не нужно: поставьте плагин для WordPress или модуль для 1С-Битрикс и вставьте в настройки ключ API.
Откуда пришёл клиент. Код сквозной аналитики добавляет в формы скрытое поле lkt_token. Передайте его в поле tracking_token, и заявка придёт с визитом посетителя. Сквозная аналитика
Пример
Десяток строк в обработчике формы
Ответы 201 и 200 означают одно: заявка у менеджера. В первом случае создана новая, во втором обращение добавлено к существующей.
- Метки рекламыUTM, страница формы и реферер сохраняются в блоке «Маркетинг» карточки.
- Данные посетителяIP-адрес и браузер передаёт ваш сервер в полях ip_address и user_agent: CRM не подставляет вместо них свои.
- Запасной путьЕсли CRM не ответила, сохраните заявку у себя вместе с ключом Idempotency-Key и повторите запрос позже с тем же ключом: так вторая заявка не появится.
Поля запроса
Что можно передать
Передавайте то, что знаете о клиенте. Контакты, текст обращения и метки менеджер увидит в карточке заявки.
| Поле | Что передавать |
|---|---|
name, phone, email | Контакты клиента. Обязательно хотя бы одно из трёх |
message | Текст обращения |
client_needs | Что нужно клиенту: например, название формы или квиза |
source | Источник: название сайта или рекламной кампании |
service | Услуга, любой текст |
company, website | Компания и сайт клиента |
landing_page, form_page, referrer | Страница первого захода, страница формы и откуда пришёл посетитель |
ip_address, user_agent | IP-адрес и браузер посетителя. CRM их не подставляет: возьмите из запроса посетителя к вашему сайту |
utm_source, utm_medium, utm_campaign, utm_term, utm_content | Метки UTM |
ym_client_id | ClientID Яндекс Метрики |
tracking_token | Метка визита: значение скрытого поля lkt_token, которое код сквозной аналитики добавляет в формы. По ней заявка получает визит посетителя |
lkt_hp | Скрытое поле-ловушка из формы, как есть. Заполненная ловушка учитывается антиспамом CRM, в заявке не сохраняется |
spam_check_wait | true: ответ ждёт решение антиспама CRM (не дольше 4 секунд). Нужно, если обработчик сам отправляет письмо с заявкой: при action reject письмо со спамом не отправляйте |
status | Статус заявки. По умолчанию «Новая заявка». Другой статус требует у сотрудника ключа права «Менять статус» |
manager | Ответственный: uuid или email сотрудника. Без поля, null или пустая строка: менеджер по умолчанию, а без него владелец. Другого сотрудника назначит только ключ сотрудника с правом «Менять ответственного», без права ответ 403 и заявка не создаётся. Неизвестный, отключённый или чужой сотрудник: ответ 400, заявка не создаётся. Если сотрудник ключа видит только свои заявки, поле не учитывается: ответственный всегда он сам |
Вопросы
Вопросы о заявках с сайта
Можно ли отправлять заявку прямо из JavaScript на странице?
Нет. Ключ API в коде страницы увидит любой посетитель. Форма должна отправлять данные на ваш сервер, а сервер передаёт их в CRM. Если сервера нет, посмотрите чат-виджет: он ставится одной строкой кода и тоже создаёт заявки.
Какие поля обязательны?
Хотя бы одно из трёх: имя, телефон или email. Остальные поля необязательны. Слишком длинные значения обрезаются, а неизвестные поля игнорируются: заявка из-за этого не теряется.
Как CRM понимает, что обращение повторное?
По email или по телефону: в номере из 10 цифр и длиннее сравниваются последние 10, поэтому формат записи не важен, а более короткий номер (например, городской без кода) не сверяется. Передавайте телефон полностью, с кодом страны и города. Если у компании есть активная заявка с теми же контактами, новая не создаётся: в существующую добавляется событие «Повторное обращение», а в ответе приходит её номер и признак
is_duplicate.Что делать со спамом с форм?
Если антиспам формы пометил заявку, передайте её со статусом «Спам». Она сохранится в CRM под фильтром «Спам», но уведомление сотрудникам не уйдёт. Если антиспам ошибся, заявку легко найти. Статус, отличный от «Новая заявка», можно передать, только если у сотрудника, на которого выпущен ключ, есть право «Менять статус, в том числе отмечать спам» (у владельца и администраторов оно есть всегда). Без него CRM ответит
403 PERMISSION_DENIED и заявку не сохранит. Свой антиспам есть и у CRM: он оценивает заявки с форм сайта (точнее всего, когда на сайте стоит общий код) и в боевом режиме сам переводит спам в «Спам» (Антиспам). Если обработчик сам отправляет письмо с заявкой, передайте заявку в CRM до письма с полем spam_check_wait: письмо со спамом можно не отправлять.Кому назначается заявка с сайта?
Это зависит от того, какие заявки видит сотрудник, на которого выпущен ключ («Права доступа»). Если он видит все заявки компании (владелец и администраторы видят всегда), заявка уходит менеджеру по умолчанию, его выбирает администратор в разделе «Сотрудники»; если менеджер по умолчанию не назначен, владельцу компании. Форма может указать ответственного сама полем
manager (uuid или email сотрудника): другого сотрудника так назначит только ключ с правом «Менять ответственного». Если сотрудник ключа видит только свои заявки, ответственным всегда становится он сам. Поэтому ключ для формы выпускайте владельцу, администратору или тому, кто должен вести заявки с сайта. Уведомление о новой заявке в Telegram сотрудники получают по своим настройкам, в том числе тот, на кого выпущен ключ. Подробнее: заявка по ключу сотрудника.Соберите все заявки в одном месте
Регистрация по коду из письма занимает минуту. Банковская карта не нужна.
Начать бесплатно