retailCRM Документация

Публикация модуля в Маркетплейс

Вы можете разработать модуль интеграции вашего сервиса с retailCRM, который будем виден в Маркетплейсе retailCRM.

Общая схема интеграции и включения модуля

1. Пользователь видит в Маркетплейсе модуль вашего сервиса, например:

2. По нажатию на модуль открывается описание возможностей модуля:

Данное описание подготавливается и отправляется вместе с модулем на этапе проверки. Также в описании размещается кнопка Подключить, которая перенаправляет пользователя в личный кабинет вашего сервиса на страницу включения и настройки модуля.

3. Пользователь нажимает Подключить и перенаправляется в кабинет вашего сервиса:

Адрес страницы, на которую перенаправляется пользователь, также сообщается вами в момент отправки модуля на проверку. Например, http://some-service.ru/cabinet?account=https://some.retailcrm.ru, где в параметре account подставляется адрес аккаунта retailCRM. На странице включения модуля пользователю, как правило, требуется ввести адрес его аккаунта (куда стоит подставлять значение из GET-параметра account, если он передан) и API-ключ.

4. После ввода и сохранения параметров доступа к retailCRM модуль интеграции должен активировать себя в соответствующем аккаунте retailCRM с помощью метода POST /api/v5/integration-modules/{code}/edit в качестве модуля со специализированными возможностями через указание одного или нескольких типов конфигурации (к ним относится Телефония telephony, Доставка delivery и Склад store) либо в качестве обычного модуля, которые использует обычные методы API. Для специализированные типов конфигурации можно указывать дополнительные параметры, расширяющие возможности интеграции.

5. В момент активации модуль в Маркетплейсе становится активным и по нажатию на него пользователь попадает на страницу настроек модуля (для модулей типа Телефония или Доставка) либо на страницу состояния модуля (для модулей типа Склад или Маркетплейс-площадка)

6. После активации модуля пользователя требуется перенаправить обратно на страницу Маркетплейса в аккаунте retailCRM.

После этого модуль активирован и может работать с соответствующим аккаунтом retailCRM.

Подготовка модуля

Разработка модуля

В зависимости от типа вашего модуля взаимодействие с API retailCRM будет отличаться. Подробнее о порядке разработки написано в документации по каждому из типов модулей:

Для разработки модуля вы можете создать аккаунт retailCRM, после чего написать запрос в техподдержку, сообщив, что данный аккаунт будет использоваться для разработки и отладки модуля с вашим сервисом. Техподдержка переведет данный аккаунт в DEV-режим, в котором выключены платные услуги (отправка писем и SMS, добавление файлов), а также выключен биллинг, таким образом данный аккаунт станет бесплатной песочницей для разработки вашего модуля.

На этапе разработки информации о вашем модуле не будет в Маркетплейсе, но вы можете активировать модуль в вашем аккаунте retailCRM, пропустив шаги 1-3 из описания, приведенного выше и выполнив шаги 4-6.

Отправка модуля на проверку

После того, как вами завершена разработка модуля, требуется написать письмо на marketplace@retailcrm.ru со следующей информацией:

Информация для проверки модуля

1. Доступы к аккаунту в кабинете вашей системе, на котором можно проверить интеграцию

Например:

2. Адрес аккаунта retailCRM, на котором можно проверить интеграцию. В аккаунте должен быть активирован пользователь техподдержки.

Например:

3. Перечень возможностей, которые реализованы в рамках модуля

На базе этой информации будет производиться проверка модуля и будет дана обратная связь.

Информация для публикации модуля в marketplace

Также требуется информация для публикация модуля в Маркетплейсе (можно смотреть пример существующих модулей в Маркетплейсе):

  1. Текстовое описание того, что позволяет модуль и краткий перечень действий по активации
  2. Логотип вашего сервиса в svg-формате
  3. Символьный код, который будет использоваться при активации модуля через API
  4. Ссылка, куда должна вести кнопка Подключить. Это должна быть страница личного кабинета вашего сервиса, на которой активируется интеграция с retailCRM
  5. Ссылка на страницу контактов техподдержки, куда сможет обратиться пользователь в случае проблемы с модулем
  6. Ссылка на страницу документации
  7. Перечень стран, в которых можно показывать данный модуль. Обычно это зависит от стран присутствия сервиса, с которым реализована интеграция

Публикация модуля в Маркетплейсе

Техподдержка retailCRM проводит проверку модуля и сообщает замечания по работе модуля, которые требуется устранить. После того, как модуль проверен на работоспособность, он публикуется в Маркетплейсе.


Редакция от 08.09.2017 10:19