База знаний MCRM

Регистрация через API с учётом источника: SID, счётчик MCRM и Яндекс.Метрика

Зачем это нужно

Если регистрация на сайте реализована своей формой и отправляется в MCRM через API, платформа не видит переход пользователя по QR-коду, UTM-меткам или промо-параметру в URL - если не передать контекст визита.

Модуль аналитики MCRM решает это так:

  1. JS-счётчик на сайте фиксирует первый визит и URL страницы.
  2. Сервер MCRM (коробка клиента) парсит из URL промо, UTM и другие метки и запоминает их за сессией (sid).
  3. При вызове /user/register вы передаёте sid (и при необходимости ym_client_id) - MCRM привязывает регистрацию к сессии и записывает источник в карточку клиента (комментарии, промо, UTM и т.д.).
Аналитика MCRM работает только на сайтах. В мобильных приложениях sid не используется.
Пример сценария: гость сканирует QR → попадает на https://site.ru/register?promo=reklamka → счётчик отправляет URL на коробку → MCRM видит promo=reklamka → гость заполняет вашу форму → ваш код вызывает /user/register с sid из cookie mcrm_sid → в карточке клиента сохраняется источник «promo reklamka».

Шаг 1. Установить счетчик MCRM на сайт

Разместите на всех страницах, где возможен путь к регистрации (лендинг, форма, личный кабинет):
<script src="https://you_server.marketingcrm.online/frame/metric" type="text/javascript"></script>
<script type="text/javascript">
  getregKey('mcrm_js_key');
</script>
Параметр
Описание
you_server
Адрес коробки (инстанса) MCRM клиента
mcrm_js_key
Ключ счётчика. Выдаётся в поддержке MCRM
Счётчик:

  • при первом визите генерирует SID (идентификатор сессии);
  • записывает cookie mcrm_sid;
  • передаёт на коробку адрес страницы входа;
  • коробка распарсивает из URL промо, UTM (utm_source, utm_medium, …) и сохраняет за этой сессией.

Данные уходят на коробку клиента (tenant), где развёрнут API — тот же хост, с которого вызываете https://you_server.marketingcrm.online/api/v3/....

Шаг 2. Передать SID при регистрации через API

В методе POST /user/register передайте параметр sid:
Поле
Обязательность
Откуда взять
sid
Рекомендуется
Cookie mcrm_sid на домене сайта
ym_client_id
Опционально
Client ID Яндекс.Метрики (для фиксации конверсий)
phone, …
По настройкам MCRM
Ваша форма
sid можно передать в теле POST (JSON) или в query string - оба варианта поддерживаются для раздела /user.

Без sid регистрация сработает, но источник визита и промо из сессии не привяжутся.
Пример запроса:
POST https://you_server.marketingcrm.online/api/v3/user/register?api_key=YOUR_API_KEY
Content-Type: application/json
{
  "phone": "9230000000",
  "first_name": "Иванов",
  "last_name": "Иван",
  "phone_code": "1234",
  "sid": "значение_из_cookie_mcrm_sid",
  "ym_client_id": "1234567890123456789",
  "metadata": [
    { "name": "source", "value": "site_form" }
  ]
}
Код подтверждения телефона (phone_code) запрашивается через [/community/verify](https://api.mcrmkit.ru/) - обязательность полей зависит от настроек предприятия в MCRM.

Что сохранится в MCRM

При корректной цепочке (счётчик → сессия → sid в register) платформа:

  • находит сессию по sid;
  • подтягивает связанные с ней промо, UTM и прочие метки из первого URL;
  • записывает их в данные клиента при регистрации (в т.ч. в служебные поля / комментарии — по настройкам коробки).

Пользователь может дальше переходить по сайту без promo в адресной строке - для MCRM источник уже зафиксирован в сессии.

Чек-лист внедрения

  • На сайте установлен скрипт /frame/metric и вызов getregKey('…') с ключом от поддержки.
  • В DevTools → Application → Cookies есть mcrm_sid после первого захода на сайт.
  • Регистрация идёт на тот же домен, где ставился счётчик (или cookie доступны субдомену по вашей политике).
  • В POST /user/register уходит актуальный sid из cookie.
  • При использовании Метрики передаётся ym_client_id.
  • Тест: заход по ссылке с ?promo=test → регистрация → в карточке клиента виден источник/промо.

Типичные ошибки

Симптом
Вероятная причина
Регистрация есть, источника нет
Не передан sid или cookie mcrm_sid пустой (счётчик не стоит / блокировщик cookie)
sid пустой при отправке формы
Форма на другом домене без общих cookie; счётчик не на странице входа
Промо не записалось
Пользователь зарегистрировался до первого хита счётчика; сессия не создана
API 401
Неверный api_key предприятия

Ограничения

  • Аналитика и sid - только веб-сайт, не мобильное приложение.
  • Параметр sid не обязателен для API, но без него теряется привязка к визиту.
  • Стабильность цепочки зависит от корректной работы счётчика на коробке; при сбоях обращайтесь в поддержку MCRM с примером URL, времени визита и значения mcrm_sid.
2026-03-01 19:09 Инструкции