Как проходит активация модуля и взаимодействие с системой (старый метод подключения)

Скопировать ссылку на статью

Скопировано

Примечание

В данной статье описан старый метод подключения. С новым методом вы можете ознакомиться в данной статье.

          Модуль                  Пользователь                 система
       ------------------------------------------------------------------
            |                           |                          |
1.          |                        Нажимает                      |
            |                   кнопку «Подключить» -------------> |
            |                    в карточке Модуля                 |
            |                     в Маркетплейсе                   |
            |                           |                          |
            |                           |                    Перенаправление
2.          |                           | <---------------    Пользователя
            |                           |                  на форму настройки
            |                           |                          |
3.          |                       Заполняет                      |
            |                     представленную ----------------> |
            |                         форму                        |
            |                           |                          |
4.          |                           |                  Проверка введенных
            | <------------------------------------------  данных и API-ключа
            |                           |                          |
5.   Регистрация Модуля                 |                          |
        в аккаунте     ------------------------------------------> |
        системы                         |                          |
            |                           |                          |
6.    Перенаправление                   |                          |
       пользователя    ------------------------------------------> |
        в аккаунт                       |                          |
        системы                         |                          |
            |                           |                          |
       ------------------------------------------------------------------

Шаг 1

Пользователь заходит в Маркетплейс и видит ваш модуль. По нажатию на модуль открывается описание возможностей модуля и инструкция по подключению.

Информация, отображаемая в карточке модуля, вносится через партнерский кабинет. Об этом рассказано подробнее в разделе Публикация модуля.

Шаг 2

Пользователь в карточке модуля нажимает кнопку Подключить.

Шаг 3

Система перенаправляет пользователя на форму настройки модуля. Адрес данной страницы задается при публикации модуля (accountUrl).

На странице настройки модуля пользователю, как правило, требуется ввести адрес его аккаунта (куда стоит подставлять значение из GET-параметра account, если он передан) и API-ключ, а также указать дополнительные настройки модуля.

Шаг 4

Пользователь отправляет форму с настройками. В этот момент, после нажатия по кнопке «Подключить», модуль должен проверить:

1. Есть ли доступ к API по указанному API-ключу. Для этого можно выполнить запрос GET /api/api-versions, заодно проверив, доступна ли версия API, с которой работает модуль.
2. Проверить права, которые выданы API-ключу, с помощью метода GET /api/credentials. В случае нехватки прав, сообщить об этом пользователю.
3. Проверить прочие настройки модуля.

Последующие шаги указаны в актуальной статье с описанием простого подключения - ссылка.