retailCRM Documentation

API keys management

It is possible to connect several e-shops to the system, by that, as on a single platform, as well as on the different ones. These can be simple websites, landings and major e-shops on CMS systems. The customer base can be shared or different for different shops. To consider these issues by integration there is a feature of API keys management.

Keys list

To start viewing the list of all API keys you need to go to section Administration > Integration.

The keys list can be filtered by activity, access type and the shop. Below is the detailed information on fields.

Key creation and editing

To create a new API key, press “Add” button.

Key

Key token is generated and inserted automatically. It is a unique set of symbols using which, binding of a shop to the system will be made. Token length must be not less than 32 symbols.

Activity

Activity field allows to turn of access to API with current key.

Access type

If all of your shops are on a single platform (for example, multiple-website mode in 1C-Bitrix system), it is possible to set value “Access to all shops”. This way, the system module for CMS system can download orders and bind them to different shops.

If shops are on different platforms, create several keys and specify “Access to separate shops” value for each of them, and then select shops that are on a single platform.

Shops

The shops are specified, which have access to data with current API-key. Shops from the store list are selected.

Note: A problem often occurs, that a website doesn’t have a customer base. And customers with orders are added directly in the system. These are mainly landings. To combine customers from different websites in a single base you need to configure not several API keys for every website, but a single API-key with full access (or with a limited access, allowing needed websites). The landing will be able to send the order and attach it to any customer that came from any of the websites before that finding him by phone number or email.

Allowed API methods

You can allow to address only several API methods with this API key. You can get familiar with the list and the desription of methods in API methods databook.

This option is useful when you need to send the API key to third-parties, that must not have access to all the data. An example can be CPA networks, that are connected to landings. CPA networks need to collect order stauses regularly. To configure sending only needed information to CPA network you need to create a separate key, in which you turn off all unwanted methods, fro they could address only to /api/v*/orders/statuses and collect order statuses. Other methods and, as a result, other information from orders will not be available to them.


PrintEditHistory
Page last modified on July 25, 2018, at 06:04 PM