Интеграции

Интеграция RetailCRM

Кратко

Интеграция RetailCRM подключается по адресу инстанса и API-ключу (REST API v5): чтение и создание клиентов и заказов, справочники статусов, типов доставки и магазинов; AI-ассистент отвечает о статусе заказа по телефону клиента.

  • Где: «Интеграции» → RetailCRM → «Подключить»; поля «API URL» (https://myshop.retailcrm.ru), «API Key», «Код сайта (опционально)».
  • Предусловие: API-ключ из «Настройки» → «Интеграция» → «API-ключи» с правами на клиентов, заказы и справочники.
  • Проверка при подключении: GET /api/v5/credentials?apiKey=...
  • Эндпоинты: customers, orders, reference/statuses, reference/delivery-types, reference/sites, customers/create, orders/create.
  • GET передаёт apiKey в query, POST отправляет форму; «Код сайта» подставляется в поле site заказа.
На этой странице

Интеграция открывает клиентскую базу и заказы интернет-магазина мессенджерам. Клиент спрашивает в чате «где мой заказ?», AI-ассистент находит заказ в RetailCRM по телефону и отвечает статусом. Оператор создаёт заказ из диалога, не переключаясь в CRM.

Подключение по API-ключу RetailCRM с нужными правами, через REST API v5.

#Что синхронизируется

Данные RetailCRMЧтениеЗапись
КлиентыСписок с пагинацией, поиск по имени, телефону и emailСоздание: фамилия, имя, отчество, email, телефон, внешний ID, теги
ЗаказыСписок с фильтрами, статус заказаСоздание: клиент, товары, доставка, адрес, комментарий
Статусы заказовСправочник reference/statusesНет
Типы доставкиСправочник reference/delivery-typesНет
Сайты (магазины)Справочник reference/sitesЗаказ привязывается к магазину из поля «Код сайта»

#Что нужно на стороне RetailCRM

  • Адрес вашего инстанса, например https://myshop.retailcrm.ru.
  • API-ключ с правами: клиенты (чтение и запись), заказы (чтение и запись), справочники (чтение).
  • Код сайта, если в RetailCRM несколько магазинов и заказы должны попадать в конкретный.

#Как подключить

Подключение RetailCRM
  1. API URL вашей CRM.

  2. API Key.

  3. Код сайта, если магазинов несколько.

  4. Кнопка подключения.

  5. Откройте RetailCRM → «Настройки» → «Интеграция» → «API-ключи» и нажмите «Добавить».

  6. Задайте имя ключа, например «tuk-tuk.online», отметьте права на клиентов, заказы и справочники, сохраните и скопируйте ключ.

  7. Откройте раздел Интеграции, выберите RetailCRM и нажмите «Подключить»: появится форма с тремя полями.

  8. Заполните «API URL» (адрес инстанса без завершающего слэша), «API Key» и при необходимости «Код сайта (опционально)», например main.

  9. Нажмите «Подключить»: платформа вызовет GET /api/v5/credentials и при успехе отметит карточку «Интеграция подключена». При неверном ключе форма покажет «Неверный API ключ RetailCRM».

#Проверить, что работает

  1. Нажмите «Управлять» и откройте страницу RetailCRM в кабинете: во вкладке клиентов загрузится список из CRM, работает «Поиск по имени».
  2. Создайте тестового клиента в форме: он появится в RetailCRM с указанными тегами.
  3. Создайте тестовый заказ (имя, фамилия, телефон, email, товар, адрес доставки, комментарий): заказ появится в RetailCRM в магазине из поля «Код сайта».

#Что происходит после подключения

ДействиеВызов RetailCRM
Список и поиск клиентовGET /api/v5/customers?apiKey=...
Список заказов и статус заказаGET /api/v5/orders?apiKey=...
СправочникиGET /api/v5/reference/statuses, reference/delivery-types, reference/sites
Создание клиентаPOST /api/v5/customers/create
Создание заказаPOST /api/v5/orders/create (поле site берётся из «Код сайта»)

GET-запросы передают apiKey в query-параметре, POST-запросы отправляют данные формой (application/x-www-form-urlencoded).

#Ограничения

  • Используется REST API v5 RetailCRM.
  • Права ключа определяют доступ: без права на запись заказов заказ не создастся.
  • Одна интеграция = один инстанс RetailCRM; для второго магазина в том же инстансе используйте «Код сайта».
  • Двусторонней переписки внутри RetailCRM нет: сообщения остаются в tuk-tuk.online, в CRM уходят клиенты и заказы.

#Частые проблемы

ПроблемаЧто делать
Клиенты не загружаютсяПроверьте, что у ключа есть право на чтение клиентов
Заказ не создаётсяЗаполните обязательные поля: клиент (телефон или email) и хотя бы один товар
Ошибка 403У ключа нет нужных прав: создайте новый ключ с правами на клиентов, заказы и справочники
«Не удалось подключиться»Сверьте «API URL»: адрес инстанса без пути и без завершающего слэша, например https://myshop.retailcrm.ru
Заказ попал не в тот магазинУкажите код нужного магазина в поле «Код сайта» (справочник reference/sites)