To place the module, you need to register as a CRM partner and conclude an agreement. To do this, please contact us via the form on the website. After registration, you will receive by email access to the partner's personal account.
The module is added in the Modules section.
Here are some explanations about the fields that are filled in when adding a module.
System data
Symbol code
In this field you have to specify a unique symbol code of your module, which can consist of Latin characters, numbers, a hyphen and underscore sign. You have to transfer this code when activating the account module in Step 6 in the integrationModule[integrationCode] field.
Minimum version of the system API
You should specify the minimum API version. Your module will only be shown in accounts that support this API version.
URL to request a simple connection configuration
It is required to specify the address to which the request will be executed - a link to the documentation.
Permissions available to the module
In this field you have to specify the permissions that will be available to the module when connecting or updating permissions for the API key. If the module requests a permission that is not specified in this field, the system will not issue or update the API key. When updating the module, you should update the permissions in your personal account in time to avoid errors on the part of users.
Marketplace section
Your module will be displayed in the specified section of the Marketplace. If there is no appropriate section for your module you can request the creation of a new section in which you want to place the module.
Logotype
It is required to upload a vector version of the logo in svg-format.
Prices
Price per month
The amount in rubles that will be deducted monthly from the customer account for using the module is specified. If you provide a module free of charge you should enter 0 in this field. Read more in the Working with Prices section.
Price per month with discount
Along with the price per month you can specify a discounted price. Then the regular module price in the Marketplace will be displayed crossed out and the discounted price will be displayed next to it.
Trial period
If a price per month is specified, you can also specify a trial period in days. This means that from the moment of module activation in the account the module will work for free for the specified number of days and only after the trial period expires the first charge for using the module will occur.
Other
Countries
It is necessary to specify the countries in which the module operates. This is especially important if your module provides integration with a service that only works in certain countries. The Marketplace section of the account displays only those modules that have overlap with the countries of the account.
Materials All text materials are required to be presented in Russian and English. Materials in the Marketplace will be displayed in the language that is set in the account settings.
Name
The name of the module is specified here.
Features description
It is required to list the key features of the module. In the case of specialized modules for delivery and telephony you can start from the features that the API allows you to implement, specifying those that are implemented in your module.
Installation description
It is required to describe the procedure for connecting the module. You can build on installation descriptions in existing Marketplace modules. In this section it is important to specify which methods should be enabled for the API key that the customer specifies in the module connection settings. Formulations like "It is required to allow all methods for the API key" are not acceptable. Acceptable formulations: "It's necessary to allow the methods of the Warehouse and Delivery sections".
Important!
If the module supports simple connection, the extended installation description is not mandatory since the system address and API key are to be entered automatically.
Connection page address
The address of the module server, where the user will be redirected when the Connect button is clicked, is specified here.
Note
The connection page address is specified if the module does not support simple connection.
Tech support contact page
The page address with the module technical support contacts.
Module documentation page
The page address where the documentation for configuring and using the module is presented.