CRM: типовые сценарии
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Страница помогает выбрать туториал для интеграции с CRM: создать клиента или сделку, обновить карточку, получить списки, передать сквозную аналитику или встроить интерфейс приложения.
Туториалы помогают выбрать рабочий сценарий и не собирать цепочку методов вручную. В каждом сценарии указаны права доступа, порядок запросов, идентификаторы для передачи между методами, пример кода и результат, который нужно проверить.
Те же направления собраны в справочнике REST API на странице Типовые кейсы использования REST API в CRM и туториалы — там сценарии перечислены рядом с группами методов, к которым они относятся.
Быстрый переход: как выбрать направление и частые сценарии
Пользовательская документация: Как начать работать с CRM в Битрикс24
Что нужно для работы
Scope. Всем сценариям нужен scope crm. Для отдельных сценариев могут понадобиться дополнительные scope, например user для получения данных пользователей или placement для встраивания виджета. Точные scope указаны в шапке страницы сценария.
Права. Пользователю нужно право на действие с объектом CRM: чтение, добавление, изменение или удаление. Для связанных данных и виджетов нужны права, указанные в выбранном сценарии. Входящий вебхук действует в рамках своего scope, а OAuth-запрос выполняется с правами пользователя, от имени которого он отправлен.
Методы. Для новых интеграций выбирайте универсальные методы crm.item.* для работы с лидами, сделками, контактами, компаниями и смарт-процессами. Развитие объектных методов crm.lead.* и crm.deal.* остановлено; используйте их только если конкретный сценарий или ограничение API прямо этого требует.
Ответы и ограничения. Успешный вызов возвращает данные в поле result, а ошибка — поля error и error_description. Точная структура результата и ошибки конкретного метода приведены на его странице. Общие правила обработки описаны в статье Коды ошибок, ограничения на интенсивность и время выполнения запросов — в статье Лимиты REST API.
Как начать работу
- Определите задачу интеграции: создать объект, изменить данные, получить список, передать аналитику или встроить интерфейс.
- Выберите направление в таблице Как выбрать направление.
- Откройте обзор выбранного направления и найдите сценарий по задаче.
- Проверьте права доступа и scopes, которые указаны в сценарии.
- Подготовьте идентификаторы объектов CRM, полей, стадий или пользователей, которые нужны для запросов.
- Выполните методы в порядке, который описан в сценарии.
Как выбрать направление
|
Если нужно |
Откройте |
Что найдете |
|
Создать лид, контакт, компанию, сделку, дело, документ или элемент смарт-процесса |
Сценарии создания объектов CRM и связанных данных. Основные методы и группы: |
|
|
Изменить поля карточки, телефоны, email, дату дела, привязку дела или дату оплаты |
Сценарии обновления данных CRM. Основные методы и группы: |
|
|
Найти дубли, получить дела, стадии, воронки, адреса, поставщиков или элементы по фильтру |
Сценарии выборки данных из CRM. Основные методы и группы: |
|
|
Передать UTM-метки, |
Сценарии передачи данных аналитики. Основные методы: |
|
|
Добавить интерфейс приложения в карточку CRM |
Сценарии для пользовательского поля лида и вкладки карточки CRM. Основные методы и точки встраивания: |
Связь с другими объектами
Сценарии работают с основными объектами CRM и связанными данными.
Лиды, контакты, компании и сделки. Основные карточки клиентов и продаж создают, обновляют и получают универсальными методами crm.item.*. Для лидов и сделок в документации также есть объектные группы crm.lead.* и crm.deal.*, но их развитие остановлено.
Дела и таймлайн. Звонки, письма, встречи, задачи и комментарии связывают с карточками CRM через методы дел и комментариев таймлайна.
Реквизиты, адреса и товарные позиции. Связанные данные хранятся отдельно от карточки CRM. Их создают и привязывают к клиенту, сделке или документу методами реквизитов, адресов, товарных позиций и каталога.
Смарт-процессы. Пользовательские типы CRM работают через entityTypeId — идентификатор типа объекта. Для создания элементов, воронок, стадий и пользовательских полей применяют универсальные методы crm.item.*.
Сквозная аналитика. Источник обращения передают в универсальный метод crm.item.add через UTM-поля. Полный маршрут клиента связывают с созданным объектом методом crm.tracking.trace.add, потому что crm.item.add не принимает поле TRACE.
Виджеты CRM. Интерфейс приложения можно встроить в карточку CRM через пользовательское поле или вкладку. Для регистрации обработчиков используйте методы и точки встраивания виджетов.
Частые сценарии
Таблица ниже — выборка задач, с которых начинают работу с CRM. Полный список материалов смотрите в обзорах направлений: добавить данные, редактировать данные, получить списки, сквозная аналитика и виджеты CRM.