◆ Sapport для разработчиков Справочник API Каталог ошибок OpenAPI
Разделы

#Глоссарий

Статус: Доступно.

Термины платформы Sapport в алфавитном порядке. Страницы, где термин раскрыт подробнее, указаны в скобках.

Агент (CRM-агент). Автоматический исполнитель ИИ-продажника и CRM: создаёт лид, меняет статус, оценивает лид, ставит задачи, передаёт диалог оператору. Во внешней CRM агент не меняет статус сам, а присылает «запрос действия» (Запросы действий).

Арендатор. Организация-клиент платформы: её данные, ключи, кошелёк, сотрудники и сайты. Определяется только по ключу API и никогда — по параметрам запроса (см. Аутентификация).

Атрибуция. Определение источника обращения: UTM-метки, переход из поиска или ИИ-ответа, рекламный клик, первое касание. Хранится в диалоге, контакте и лиде.

Вебхук. Исходящее событие платформы на ваш HTTPS-адрес с подписью Sapport-Signature (см. Вебхуки).

Действие стратега. Ожидающее действие, которое стратег предложил в чате: proposed → confirmed → executed или failed; может быть отменено (cancelled) или истечь через 7 суток (expired). Подтверждается и отменяется через /strategist/actions (Действия и темы).

Журнал выдач ПДн. Запись о каждой выдаче персональных данных через API: кто, что, сколько записей; без значений. Виден арендатору в кабинете и по GET /disclosures, хранится 3 года (Ячейки и данные).

Загрузчик. Скрипт loader.js?k=<публичный ключ>: одной строкой подключает JS-трекер, сбор поведения, чат и управление согласием (analytics/02-loader.md).

Идемпотентность. Свойство операции: повтор с тем же Idempotency-Key не создаёт дубль (см. Соглашения).

Интеграция. Служебная учётная запись арендатора для программного доступа. Без входа в кабинет, со своей ролью; владеет ключами API (см. Аутентификация).

Канал. Источник и приёмник диалогов: веб-чат на сайте, мессенджер, собственный канал арендатора (канал api). Идентификатор канала веб-чата (channel_id) открыт и встраивается в код сайта.

Ключ API. Секретная строка sap_<ячейка>_<режим>_<идентификатор>_<секрет>. Показывается один раз. Хранится только у клиента (см. Аутентификация).

Коннектор. Протокол и модули, связывающие платформу с CMS арендатора: подписанный серверный маяк, загрузчик, публикация статей. Модули есть для Bitrix и WordPress; FastAPI и Nuxt — не опубликованы (analytics/03-cms-modules.md, articles/03-publishing-modules.md).

Контакт. Человек, с которым ведётся общение: ФИО, почта, телефон, метки, история. Содержит ПДн.

Кошелёк. Баланс арендатора в валюте его ячейки. С него списывается плата за платные операции: ответы ИИ, оценка лидов, генерация статей, ходы стратега.

Курсор. Подписанный маркер позиции в списке (next_cursor). Непрозрачен для клиента (см. Соглашения).

Лид. Потенциальная сделка, связанная с диалогом и контактом: статус, оценка, источник, значение, ответственный. Лид всегда существует на платформе; меняется только то, кто владеет его полями (crm/01-modes.md).

Маяк. Короткий запрос, фиксирующий визит страницы. Бывает JS-маяк из браузера и серверный подписанный маяк из CMS (видит ботов и ИИ-краулеров) (analytics/04-js-tracker.md).

Мёртвое письмо. Доставка вебхука, не принятая и после восьмого повтора. Остаётся в журнале доставок, её можно переотправить (Вебхуки).

Надгробие. Запись {id, deleted_at} об удалённом ресурсе, которую список отдаёт при include_deleted=true; хранится 30 суток (Соглашения).

Область (scope). Право, выданное ключу: например leads:read. Фактические права запроса — пересечение областей, роли интеграции, текущих прав владельца и тарифа.

Оператор ПДн. Лицо, определяющее цели и способы обработки персональных данных. Для данных клиентов арендатора это арендатор; платформа выступает обработчиком по его поручению (см. Ячейки и данные).

Операция (operation). Единый конверт асинхронной работы: 202 {operation: {id, type, status, …}}. Статусы: queued, running, succeeded, failed, canceled. Результат — GET /operations/{id}, параметр ?wait (до 20 с) или событие operation.completed (Соглашения).

Ответ ИИ (ai_reply). Поле {status, reason?} в ответе на сообщение клиента и в событии message.created: status — replied, queued или skipped; reason объясняет пропуск (operator_active, spam, flow_reply, ai_unavailable_handoff, no_agent, daily_limit) (Соглашения).

ПДн. Персональные данные: имя, почта, телефон и т. п. Области с ПДн отмечены в таблице Аутентификация.

Первое касание. Источник, с которого посетитель впервые пришёл на сайт: UTM, идентификаторы кликов, страница входа, реферер.

Песочница. Тестовый арендатор ячейки с вымышленными данными для тестовых ключей. Статус: Планируется.

Платная операция. Вызов, списывающий деньги с кошелька (см. Соглашения).

Профиль редакции. Настройки арендатора для генерации статей. Без него генерация недоступна (editorial_profile_required).

Публикатор. Модуль генерации, согласования и публикации статей на сайт арендатора (articles/).

Режим CRM. Настройка арендатора: internal (наша CRM), external (источник истины — внешняя CRM после принятия лида), both (поле за полем) (crm/01-modes.md).

Сессия (чата). Подписанный токен посетителя виджета; живёт в браузере до 30 суток, подписан и не зашифрован.

Стратег. ИИ-маркетолог: регулярные отчёты с доказательствами и ожидаемым эффектом, очередь тем, действия чата, разговор (Стратег).

Тема стратега. Элемент очереди тем для статей, который предлагает стратег: утверждается или отклоняется (/strategist/topics). Утверждение генерацию статьи не запускает (Действия и темы).

Тонкая нагрузка. Событие вебхука, содержащее только идентификаторы и тип, без ПДн (см. Вебхуки).

Ячейка. Независимая боевая копия платформы со своей базой, секретами и юрлицом: RU, EN, ID (см. Ячейки и данные).

api_access. Признак лицензии, разрешающий программный доступ.

include_pii. Флаг подписки на вебхук: включает ПДн в события lead.*, contact.*, conversation.*. По умолчанию false (Вебхуки).

livemode. Поле конверта события: true для боевых данных, false для тестовых событий (webhook.test) и песочницы.

problem+json. Формат ошибок application/problem+json по RFC 9457 (см. Соглашения).

request_id. Идентификатор запроса из заголовка X-Request-Id и тела ошибки; нужен поддержке.

usage. Блок {cost: {amount, currency}, model} в ответах платных операций и в operation: сколько списано и какой моделью выполнено (Соглашения).