К системе можно подключить несколько интернет-магазинов, причем как на одной платформе, так и на разных. Это могут быть обычные сайты, лендинги и полноценные интернет-магазины на CMS-системах. База клиентов может быть общая, а может быть разная для разных магазинов. Чтобы учесть данные нюансы при интеграции, предусмотрена возможность управления API-ключами.
Увидеть весь список созданных ключей можно во вкладке «Ключи доступа к API», которая находится в разделе Интеграция.
В списке ключей значение ключа отображается в маскированном виде — показываются только первые 4 и последние 4 символа, например snWb...ck7H.
Список ключей можно отфильтровать по активности, типу доступа, магазину и комментарию. По полю «Комментарий» поиск выполняется по частичному совпадению.
Также в списке выводятся дата и время последнего использования API-ключа. Эти данные хранятся 3 месяца. Если значение отсутствует, это означает, что ключ не использовался либо использовался более 3 месяцев назад.
Подробнее по полям описано ниже.
Чтобы создать новый ключ API, нажмите кнопку «Добавить».
Ключ
Значение ключа генерируется автоматически. Это уникальный набор символов, по которому выполняется привязка магазина или интеграции к системе.
В форме создания ключ выводится полностью. Рядом с полем доступна кнопка копирования.
После создания API-ключа его исходное значение больше не показывается полностью и не редактируется.
В форме редактирования и в общем списке ключей значение отображается в маскированном виде — показываются только первые 4 и последние 4 символа.
Тип доступа
Если все магазины находятся на одной платформе (например, режим многосайтовости в системе 1С-Битрикс), то можно установить значение «Доступ ко всем магазинам». Таким образом, модуль системы для CMS-системы сможет выгружать заказы и привязывать их к разным магазинам.
Если же магазины находятся на разных платформах, то заведите несколько ключей и для каждого укажите значение «Доступ к отдельным магазинам» и далее выберите магазины, находящиеся на одной платформе.
Магазины
Указываются магазины, к данным которых есть доступ по данному API-ключу. Информация ниже актуальна для сайтов, которые не хранят на своей стороне клиентов и заказы (например, лендинг).
Примечание
Часто встречается проблема, что на сайте нет своей базы клиентов. И клиенты с заказами заводятся напрямую в систему. Чтобы объединить клиентов с разных сайтов в одну базу, надо настроить не несколько API-ключей к каждому сайту, а один API-ключ с полным доступом (либо с ограниченным доступом, разрешив необходимые сайты). Лендинг сможет отправлять заказ и прикреплять к любому клиенту, который пришел с любого из сайтов до этого, находя его по телефону или по электронной почте.
Комментарий
Поле «Комментарий» можно использовать для обозначения назначения API-ключа.
Комментарий помогает находить нужные ключи в общем списке. Для поиска доступен текстовый фильтр по этому полю.
Поиск выполняется по частичному совпадению. Например, если в комментарии указано «Ключ для Postman», такой ключ будет найден по запросам ключ, для или postm.
Разрешенные действия в API
Данные доступные через API разделены на группы.
С перечнем и описанием доступных групп и методов вы можете ознакомиться в справочнике методов API.
Вы можете разрешить по данному API-ключу доступные действия в рамках группы - получение и/или изменение.
Данная опция полезна, когда необходимо передать API-ключ третьим лицам, которые не должны иметь доступ ко всем данным. Примером могут служить сайты-витрины, в которых нет полноценной функциональности интернет-магазинов. Сайт-витрина может создавать новые заказы на основе запросов пользователей. Для настройки отправки заказов в систему надо создать отдельный ключ и деактивировать все лишние области, кроме редактирования заказов, чтобы осталась возможность создавать заказы. Остальные операции, как и получение информации о заказах, будут недоступны.
Примечание
При клике на заголовок области - галочки будут проставляться/сниматься у всего блока.