В кабинете компании есть возможность управлять токенами самостоятельно. Для настройки необходимо перейти в Настройки - Управление API-токенами.
Раздел и функционал доступен для владельца компании и роли Администратор.
Если у компании уже есть ключи — они будут отображаться в этом разделе с указанием прав и срока действия.
Создание токенов
Кнопка «Создать токен» генерирует токен с заданными параметрами
- Поле «Название» (Название может содержать буквы, цифры и символы ʼ'-). Для создания токена название указывать не обязательно, тогда токен создастся с автоматическим названием. Например: Ключ 12334567.
- Поле «Действителен до» (максимально возможный срок — 1 год, минимально — 1 день)
- Дропдаун с настройкой доступа (только чтение/чтение и запись/нет доступа) под каждый набор методов.
В публичном API есть 7 методов, которые настраиваются в кабинете:
|
Доступные методы API |
Где настраивать права доступа |
|
Orders |
Заказы и сообщения |
|
Products |
Продукты и группы |
|
Groups |
Продукты и группы |
|
Clients |
Клиенты |
|
Messages |
Заказы и сообщения |
|
Delivery |
Заказы и сообщения |
|
PaymentOption |
Настройки |
Обратите внимание! Минимум к одному блоку должны быть открыты права, или отобразится ошибка:
Права доступа и коды ошибок:
- нет доступа — в ответ на любые запросы возвращается ошибка (403 Forbidden);
- только чтение — в ответ y GET-запросы успех (200 OK) на POST-запросы возвращается ошибка (403 Forbidden);
- чтение и запись — и GET и POST проходят успешно (200 OK).
Если у токена закончился срок действия, вернется 401 код ошибки (401 Not Authenticated).
Возможные действия с созданным токеном:
- Просмотр. При нажатии откроется поп-ап с токеном, который можно скопировать (токен сохранится в буфере обмена).
- Редактирование. При нажатии открывается поп-ап с полями, которые можно редактировать. Все поля редактируемые и изменения применяются онлайн после сохранения изменений. Можно менять название, срок действия (не более чем 1 год от текущей даты изменений), права доступа.
- Удаление. Токен можно удалить, но обратите внимание, что удаление токена происходит безвозвратно. Как только вы подтвердите действие удаления токена, он не будет отображаться в кабинете. А при попытке получить данные с таким токеном — будет выдаваться ошибка 401 Not Authenticated.
Уведомление о деактивации токена
За 30, а также за 7 дней до деактивации токена в кабинет компании и пуш-сообщением отправляется уведомление о скором окончании срока действия токена.
Чтобы продолжить работу с api, обновите срок действия токена или создайте новый.
