How the module is activated and how it interacts with the system (old connection method)

Copy the link to the article

Copied

Note

This article describes the old connection method. You can familiarize yourself with the new method in this article.

          Module                  User                 system
       ------------------------------------------------------------------
            |                           |                          |
1.          |                        Clicks                      |
            |                   the “Connect” button -------------> |
            |                    in the Module card                 |
            |                     in the Marketplace                   |
            |                           |                          |
            |                           |                    Redirecting
2.          |                           | <---------------    the User
            |                           |                  to the settings form
            |                           |                          |
3.          |                       Fills in                      |
            |                      the submitted ----------------> |
            |                         form                        |
            |                           |                          |
4.          |                           |                  Validation of entered
            | <------------------------------------------  data and API key
            |                           |                          |
5.   Module registration                 |                          |
        in the system     ------------------------------------------> |
        account                         |                          |
            |                           |                          |
6.    Redirecting                   |                          |
       the user    ------------------------------------------> |
        to the system                       |                          |
        account                          |                          |
            |                           |                          |
       ------------------------------------------------------------------

Step 1

The user enters the Marketplace and sees your module. Clicking on the module opens a description of the module features and instructions for connection.

The information displayed in the module card is entered via the partner account. This is described in more detail in the Module Publishing section.

Step 2

The user clicks the Connect button in the module card.

Step 3

The system redirects the user to the module configuration form. The address of this page is set when publishing the module (accountUrl).

On the module settings page the user, as a rule, is required to enter his account address (where the value from the account GET-parameter should be substituted if it is transferred) and the API-key, as well as to specify additional module settings.

Step 4

The user submits a form with the settings. At this point, after clicking on the "Connect" button, the module should check:

1. Whether there is access to the API using the specified API-key. To do this you can make a GET /api/api-versions request checking at the same time whether the API version with which the module works is available.
2. Verify the rights issued to the API-key using the GET /api/credentials method. In case of insufficient rights, inform the user about it.
3. Check other module settings.

The next steps are specified in the current article describing a simple connection - link.