Creating and editing an API key
Copy the link to the article
Copied

You can connect several online stores to the system, both on the same platform and on different ones. These can be regular sites, landing pages and full-fledged online stores on CMS systems. The customer base can be general, or it can be different for different stores. To take into account these nuances when integrating, the possibility to manage API keys is provided.

You can see the entire list of created keys in the "API access keys" tab, which is located in the "Integration" section.

The list of keys can be filtered by activity, type of access, and by store. More details on the fields are described below.

To create a new API key, click the "Add" button.

Key

The key token is generated and substituted automatically. This is a unique set of symbols used to bind the store to the system. The token length must be at least 32 characters.

Access type

If all stores are on the same platform (for example, multi-site mode in the 1C-Bitrix system), then you can set the value "Access to all stores". Thus, the system module for the CMS system will be able to export orders and bind them to different stores.

If the stores are located on different platforms, then create several keys and for each specify the value "Access to individual stores" and then select the stores located on the same platform.

The stores

Here are specified the stores to the data of which you have already had access using this API key. The information below is relevant for sites that do not store customers and orders on their side (for example, a landing page).

Note

A common problem is that the site does not have its own customer base. And customers with orders are entered directly into the system. To combine customers from different sites into one database, you need to configure not several API keys for each site, but one API key with full access (or with limited access by allowing the necessary sites). The landing page will be able to send an order and attach it to any customer who came from any of the sites before, finding it by phone or e-mail.

Allowed API Methods

You can allow access only to some API methods using this API key. The list and description of the methods can be found in the reference book of API methods.

This option is useful when you need to give the API key to third parties who should not have access to all data. An example is CPA networks that connect to landing pages. CPA networks need to regularly pick up order statuses. To configure sending only the necessary information to the CPA system, you need to create a separate key in which to disable all unnecessary methods so that, for example, they can only access /api/v*/orders/statuses and pick up order statuses. The rest of the methods and, as a result, other information from the orders will not be available to them.

Note

When you click on the title of API methods, the checkboxes will be checked / unchecked for the entire block.

Thank you for your feedback.
Was this article helpful?
No
  • Рекомендации не помогли
  • Нет ответа на мой вопрос
  • Текст трудно понять
  • Не нравится описанный функционал
Yes
Next article
Working with the marketplace
The marketplace section contains all of the currently available modules for integration with your store.
Didn't find the answer to your question?
Get help
Didn't find the answer to your question?
Technical support specialist is ready to help!

Feedback

By clicking the button, you agree to the terms of the user agreement

Message sent!

A technical support specialist will soon read your request and reply to you.

Message not sent!

An unexpected error occurred. We have already been notified of the problem and will fix it soon.