GPT
Поддержка клиентов Бесплатный план с лимитами; платные планы и дополнительные модули

RetailCRM API

RetailCRM API соединяет интернет-магазин с CRM: читает и изменяет заказы, клиентов и статусы, чтобы синхронизировать данные без ручного переноса.

Что это

RetailCRM API, также встречается написание Retail CRM API, - интерфейс для подключения своей программы к CRM интернет-магазина. Через него можно получать сведения о заказах и клиентах, передавать новые заказы и синхронизировать изменения между системами.

Для поддержки он полезен тем, что даёт проверяемый источник статуса заказа. Бот или менеджер получает данные из CRM, а не угадывает ответ по переписке. Для первого подключения достаточно операции чтения; разрешения на изменение заказов и платежей выдавать не нужно.

Этот материал посвящён REST API v5, а не отдельному AI-продукту. У RetailCRM могут быть AI-модули, но их возможности нельзя автоматически приписывать каждому методу API. Если вы подключаете внешнего агента, он должен получать ограниченный набор данных и действий; важные изменения подтверждает человек.

Ключевые параметры

  • Категория: CRM и поддержка
  • Сложность: Для разработчика
  • Запуск: Около 30 минут
  • Open-source: Нет
  • Данные: Не известно
  • Чувствительные данные: Нужно оценивать отдельно
API Веб-кабинет Файлы HTTP API Cloud

Сильные стороны

  • Заказы и клиенты доступны через один API: интеграция может опираться на данные CRM, а не на копии в переписке.
  • Метод orders/statuses возвращает статусы по идентификаторам заказов без загрузки всей карточки клиента.
  • Ключу можно ограничить разрешения и доступные магазины, отделив чтение от изменения данных.
  • Для синхронизации доступны история изменений и постраничное чтение: не обязательно постоянно перечитывать все заказы.
  • Есть русская документация с параметрами, разрешениями и форматами ответов; стандартный HTTP-клиент подходит для первого теста.

Ограничения

  • Нужно сопоставить магазины, идентификаторы и справочники статусов. Внешний номер заказа не всегда совпадает с внутренним id.
  • Действуют ограничения частоты запросов и постраничная выдача. Паузы, обработку ошибок и продолжение синхронизации настраивает интеграция.
  • Повтор создания заказа после потери ответа может дать дубль. Храните внешний идентификатор и проверяйте результат до повтора.
  • API использует apiKey; при GET секрет входит в параметры запроса. Скрывайте его в логах и не публикуйте URL из HTTP-клиента.
  • API не является языковой моделью. AI-модули, тариф CRM, дополнительные каналы и работа внешних моделей имеют отдельные условия и расходы.

Как использовать

1. Подготовьте аккаунт RetailCRM и тестовый магазин. Создайте один заказ с вымышленными данными. Запишите внутренний id из карточки или её адреса: не подменяйте его отображаемым номером заказа. Первый тест только читает статус.
2. В Администрирование → Интеграция → Ключи доступа к API создайте отдельный ключ. Разрешите только чтение заказов (order_read) и доступ к тестовому магазину. Сохраните секрет CRM_API_KEY и адрес своего аккаунта CRM_BASE, например https://YOUR-ACCOUNT.retailcrm.ru, в приватном HTTP-клиенте.
3. Создайте GET-запрос {{CRM_BASE}}/api/credentials и добавьте параметр apiKey = {{CRM_API_KEY}}. Этот адрес без /v5/. Проверьте success = true, наличие order_read в scopes и доступ к тестовому магазину по siteAccess и sitesAvailable. Не сохраняйте URL с раскрытым ключом в публичных логах.
4. Создайте GET-запрос {{CRM_BASE}}/api/v5/orders/statuses. Добавьте два параметра: apiKey = {{CRM_API_KEY}} и ids[] = внутренний id тестового заказа. Отправьте запрос. В orders должна появиться запись с тем же id и кодом status.
5. Сравните ответ с карточкой заказа в CRM. Код status - машинное обозначение, а не обязательно подпись на экране. Для расшифровки можно отдельно подключить справочник /api/v5/reference/statuses с правом reference_read. Если orders пуст, проверьте id и доступ магазина; при 403 проверьте ключ, разрешения и ограничения IP.
6. Повторите чтение: заказ не должен измениться и новая запись не должна появиться. Первый результат готов - статус тестового заказа получен из CRM. Для боевой интеграции настройте таймауты, ограничение запросов и маскирование логов; запись подключайте отдельно, с проверкой внешнего идентификатора и подтверждением важных изменений.

Примеры сценариев

  • Проверка заказа: интеграция получает status для одного внутреннего id и показывает его поддержке без передачи всей карточки клиента.
  • Импорт: сайт передаёт заказ с устойчивым externalId. До повторного создания интеграция выясняет, не был ли заказ уже сохранён.
  • Синхронизация: обработчик читает историю изменений и последующие страницы выдачи, сохраняя свою контрольную точку.
  • AI-ответ: внешняя модель получает только нужные факты о заказе и готовит черновик. Оплата, возврат и другие значимые изменения остаются на подтверждении.

Доступ и оплата

  • Модель оплаты: Бесплатный тариф + платные возможности
  • Бесплатный тариф: Да
  • Пробный доступ: Да
  • Работа в РФ: Нужно проверять
  • VPN: Не известно
  • Русский интерфейс: Да
  • Русский язык: Не известно

Есть русский интерфейс и рублёвые тарифы. На дату проверки бесплатный план рассчитан на одного пользователя, до 300 заказов в месяц и базу до 5000 клиентов; API указан среди его возможностей. Для платного плана предусмотрен пробный период 14 дней. Дополнительные модули и каналы проверяйте отдельно. Доступ из конкретной сети и оплата конкретной картой здесь не тестировались.

Какой тариф выбрать

  • Для тестового чтения заказа рассмотрите бесплатный план или пробный доступ: сначала проверьте ключ, права и нужные методы.
  • Для работающего магазина сравните платные планы по пользователям, заказам, клиентской базе и необходимым каналам.
  • В бюджет включите дополнительные модули, разработку и обслуживание интеграции. Если есть внешняя AI-модель, её расходы не входят автоматически в тариф CRM.

Когда не подходит

  • Прямое подключение браузера покупателя с секретным API-ключом.
  • Автоматическое изменение платежей или возвратов без проверки и подтверждения.
  • Отправка всей истории клиентов в модель ради ответа о статусе одного заказа.

Альтернативы

bitrix24-rest-api amocrm-api hubspot-crm-api

Bitrix24 REST API стоит сравнить, если уже используете экосистему Bitrix24 и её CRM. amoCRM API ориентирован на сделки и воронку продаж; модель интернет-магазина придётся сопоставить отдельно. HubSpot CRM API - вариант для процессов в HubSpot, с собственной схемой данных и условиями доступа. Это не взаимозаменяемые адреса API: потребуется адаптация сущностей, прав и статусов.

Параметры для подборок

API Бесплатный тариф sales support Операционные задачи Для разработчиков Бизнес Для бизнеса

FAQ

RetailCRM API - это готовый AI-агент?

Нет, это интерфейс доступа к данным и действиям CRM. AI-модули платформы и внешние агенты подключаются по своим условиям. Сам вызов REST-метода не добавляет рассуждения или генерацию текста.

Где создать ключ и какие права нужны для первого теста?

Откройте Администрирование → Интеграция → Ключи доступа к API. Для чтения статуса заказа достаточно order_read и доступа к нужному магазину. Права на запись для этого теста не нужны.

Что передавать в ids[]: номер заказа или id?

Внутренний id RetailCRM. Отображаемый номер может отличаться. Для идентификатора из внешней системы у orders/statuses есть отдельный параметр externalIds[].

Можно ли проверить подключение на бесплатном плане?

Да, API указан среди возможностей бесплатного плана. На дату проверки его лимиты: один пользователь, до 300 заказов в месяц и до 5000 клиентов. Доступность дополнительных модулей и выбранных операций проверяйте отдельно.

Почему запрос возвращает 403 или пустой orders?

При 403 проверьте ключ, права и ограничения по IP. Пустой orders может означать неверный id или отсутствие доступа к магазину. HTTP 200 и success = true не доказывают, что найден именно нужный заказ: сравните id и статус с CRM.

Можно отправить JSON в POST и использовать Bearer?

Не переносите эту схему автоматически: REST API v5 использует параметр apiKey, а параметры POST передаются как application/x-www-form-urlencoded. Составной объект, например order, передаётся JSON-строкой в соответствующем поле формы. Сверяйте конкретный метод.

Лучше всего подходит

Типовые задачи

Показывать поддержке актуальный статус конкретного заказа. Передавать заказы с сайта в CRM и сопоставлять их по внешним идентификаторам. Синхронизировать сведения о клиентах и изменения заказов с другими системами. Давать AI-помощнику ограниченный доступ к данным для черновика ответа.

Упоминания

Статьи, где встречается RetailCRM API