Содержание
Для размещения модуля вам требуется зарегистрироваться как партнер CRM и заключить договор. Для этого обратитесь к нам через форму на сайте. После регистрации вам на электронную почту придут доступы к личному кабинету партнера.
Модуль добавляется в разделе Модули.
Дадим некоторые пояснения по полям, которые заполняются при добавлении модуля.
Системные данные
Символьный код
В данном поле требуется указать уникальный символьный код вашего модуля, который может состоять из латинских символов, цифр, дефиса и знака подчеркивания. Данный код вы должны передавать при активации модуля аккаунта в поле integrationModule[integrationCode]. Подробнее активация описана в статье «Как происходит подключение и активация модуля в системе».
Если модуль содержит собственные страницы внутри CRM, этот же код используется в адресе страницы вида:
/modules/<moduleCode>/<pageCode>Минимальная версия API системы
Требуется указать минимальную версию API. Ваш модуль будет показан только в тех аккаунтах, которые поддерживают данную версию API.
URL для запроса конфигурации простого подключения
Требуется указать адрес, по которому будет выполнен запрос - configUrl..
Доступные модулю разрешения
В данном поле требуется указать разрешения, которые будут доступны модулю при подключении или обновлении разрешений для API-ключа. Если модуль запросит разрешение, не указанное в этом поле, то система не выдаст или не обновит API-ключ. При обновлении модуля следует своевременно обновлять разрешения в личном кабинете, чтобы избежать ошибок со стороны пользователей.
Раздел Маркетплейса
Ваш модуль будет выводиться в указанном разделе Маркетплейса. Если для вашего модуля нет подходящего раздела, вы можете запросить создание нового раздела, в котором хотите разместить модуль.
Логотип
Требуется загрузить векторную версию логотипа в svg-формате.
Цены
Цена в месяц
Указывается сумма в рублях, которая будет ежемесячно списываться с клиента за использование модуля. Если вы предоставляете модуль на бесплатной основе, то в данном поле необходимо указать 0. Подробнее читайте в разделе Работа с ценами.
Цена в месяц со скидкой
Наряду с ценой в месяц можно указать цену со скидкой. Тогда в Маркетплейсе обычная цена модуля будет выводиться зачеркнутой, а рядом выводиться цена со скидкой.
Срок пробного периода
Если указана цена в месяц, то можно также выставить срок пробного периода в днях. Это значит что с момента активации модуля в аккаунте указанное количество дней модуль будет работать бесплатно, и только по истечении пробного периода произойдет первое списание за использование модуля.
Прочее
Страны
Необходимо указать страны, в которых работает модуль. Это особенно важно, если ваш модуль обеспечивает интеграцию с каким-то сервисом, который работает только в определенных странах. В Маркетплейсе аккаунта выводятся только те модули, у которых есть пересечение со странами аккаунта.
Материалы
Все текстовые материалы требуется указывать на русском и английском языках. В Маркетплейсе материалы будут выводиться на том языке, который стоит в настройках аккаунта.
Материалы карточки должны соответствовать фактическому поведению модуля.
Название
Здесь указывается название модуля.
Описание возможностей
Требуется перечислить ключевые возможности модуля. В случае специализированных модулей для доставки и телефонии можно отталкиваться от тех возможностей, которые позволяет реализовать API, указав те из них, что реализованы в вашем модуле.
Если модуль содержит frontend-часть, в описании возможностей полезно явно указать:
- где именно появляются элементы модуля в CRM;
- есть ли у модуля собственные страницы;
- какие действия пользователь выполняет прямо в интерфейсе CRM.
Описание установки
Требуется описать порядок подключения модуля. Можно отталкиваться от описаний установки в существующих модулях Маркетплейса. В данном разделе важно указать, какие методы нужно включить для API-ключа, который клиент указывает в настройках подключения модуля. Не допускаются формулировки вида «Требуется разрешить все методы для API-ключа». Допустимые формулировки: «Необходимо разрешить методы разделов Склад и Доставки».
Важно!
В случае, если модуль поддерживает простое подключение, то расширенное описание установки не обязательно, так как адрес системы и API-ключ должны прописываться автоматически.
Если модуль публикует собственные страницы, в описании установки также полезно указать, где эти страницы будут доступны после подключения. Подробно этот сценарий описан в статье «Создание собственных страниц JS-модулей».
Адрес страницы подключения
Указывается адрес сервера модуля, куда будет перенаправлен пользователь в момент нажатия кнопки Подключить.
Примечание
Адрес страницы подключения указывается в том случае, если модуль не поддерживает простое подключение.
Страница контактов техподдержки
Адрес страницы, где указаны контакты техподдержки модуля.
Страница документации по модулю
Адрес страницы, где представлена документация по настройке и использованию модуля.
Frontend-часть JS-модуля
Если модуль содержит frontend-часть:
- JS-функциональность необходимо включить в карточке модуля в партнерском кабинете;
- помимо общей карточки интеграционного модуля требуется подготовить дескриптор расширения.
В актуальном сценарии в дескрипторе должны быть согласованы следующие поля:
| Поле | Описание |
|---|---|
uuid |
Идентификатор frontend-части модуля. По нему CRM различает расширения и строит URL ресурсов frontend-части. |
entrypoint |
Точка входа frontend-части модуля. Для актуального сценария через worker указывается JS-файл. Для legacy-сценария iframe может использоваться HTML-страница. |
runner |
Способ запуска frontend-части модуля. Для новых модулей, v1-endpoint и собственных страниц требуется указать worker. Значение iframe относится к legacy-сценарию и не рекомендуется для новых модулей. |
targets |
Перечень точек встраивания, в которых CRM должна отображать виджеты модуля. Если модуль добавляет виджеты на существующие страницы CRM, в дескрипторе требуется указать targets. Список доступных точек встраивания описан в статье «Точки встраивания JS-модулей». |
pages |
Описание собственных страниц модуля внутри CRM. Если модуль добавляет собственные страницы, в дескрипторе требуется указать pages. Поле pages может содержать короткую запись строкой с кодом страницы или объект с настройками: code, menu, parentMenuItemCode, menuItemOrdering, menuItemTitle, pageHelpLink. |
stylesheet |
Ресурс со стилями frontend-части модуля. Если он задан, CRM подключает его вместе с frontend-приложением. |
baseUrl |
Базовый адрес сервера модуля. Относительно него CRM получает ресурсы frontend-части и выполняет backend-вызовы модуля. |
После публикации и активации собственные страницы модуля открываются внутри CRM по адресу:
/modules/<moduleCode>/<pageCode>Подробно структура pages описана в статье «Создание собственных страниц JS-модулей».
Перед публикацией следует проверить, что:
| Что проверить | Описание |
|---|---|
uuid |
Соответствует публикуемым ресурсам frontend-части. |
entrypoint |
Соответствует фактическому способу запуска модуля. |
runner |
Соответствует сценарию запуска; для новых модулей, v1-endpoint и страниц указан worker. |
targets |
Содержат только реально поддерживаемые точки встраивания. |
pages |
Содержат корректные коды страниц и настройки меню. |
baseUrl |
Доступен CRM и согласован с backend-частью модуля. |