retailCRM Документация

Управление API-ключами

К системе можно подключить несколько интернет-магазинов, причем как на одной платформе, так на разных. Это могут быть обычные сайты, лендинги и полноценные интернет-магазины на CMS-системах. База клиентов может быть общая, а может быть разная для разных магазинов. Чтобы учесть данные нюансы при интеграции, предусмотрена возможность управления API-ключами.

Список ключей

Чтобы приступить к просмотру списка всех ключей API, надо зайти в раздел Администрирование > Интеграция.

Список ключей можно отфильтровать по активности, типу доступа и по магазину. Подробнее по полям описано ниже.

Создание и редактирование ключа

Чтобы создать новый ключ API, нажмите кнопку «Добавить».

Ключ

Токен ключа генерируется и подставляется автоматически. Это уникальный набор символов, по которым будет идти привязка магазина к системе. Длина токена должна быть не меньше 32 символов.

Активность

Поле Активность позволяет выключить доступ к API по данному ключу.

Тип доступа

Если у вас все магазины находятся на одной платформе (например, режиме многосайтовости в системе 1С-Битрикс), то можно установить значение «Доступ ко всем магазинам». Таким образом, модуль системы для CMS-системы сможет выгружать заказы и привязывать их к разным магазинам.

Если же магазины находятся на разных платформах, то заведите несколько ключей и для каждого укажите значение «Доступ к отдельным магазинам» и далее выберите магазины, находящиеся на одной платформе.

Магазины

Указываются магазины, к данным которых есть доступ по данному API-ключу. Выбираются магазины из списка магазинов.

Примечание: Часто встречается проблема, что на сайте нет своей базы клиентов. И клиенты с заказами заводятся напрямую в систему. Это в основном лендинги. Чтобы объединить клиентов с разных сайтов в одну базу, надо настроить не несколько API-ключей к каждому сайту, а один API-ключ с полным доступом (либо с ограниченным доступом, разрешив необходимые сайты). Лендинг сможет отправлять заказ и прикреплять к любому клиенту, который пришел с любого из сайтов до этого, находя его по телефону или по электронной почте.

Разрешенные методы API

Вы можете разрешить по данному API-ключу обращаться только к некоторым методам API. С перечнем и описанием методов вы можете ознакомиться в справочнике методов API.

Данная опция полезна, когда необходимо передать API-ключ третьим лицам, которые не должны иметь доступ ко всем данным. Примером могут служить CPA-сети, которые подключаются к лендингам. CPA-сети необходимо регулярно забирать статусы заказов. Для настройки отправки в CPA-систему только нужной информации надо создать отдельный ключ, в котором выключить все лишние методы, чтобы они, например, могли только обращаться к /api/v*/orders/statuses и забирать статусы заказов. Остальные методы и, как следствие, прочая информация из заказов им будет недоступна.


Редакция от 13.12.2016 10:43