Перейти к содержимому
Помощь
Русский
Настройки магазина

Как создать API-токены доступа для интеграций?

Создавайте до 40 API-токенов доступа с правами чтения товаров, чтения заказов и работы с вебхуками, окном доступа к данным и необязательным сроком истечения. Узнайте об аутентификации, лимите 60 запросов в минуту и о том, как редактировать или удалять токены.

Для чего нужны токены доступа

Токены доступа позволяют вашим собственным скриптам и сторонним интеграциям общаться с API Storeep от имени вашего магазина. Каждый токен несёт фиксированный набор прав, необязательное окно данных и необязательную дату истечения. Токены безопаснее, чем передача логина от панели, потому что вы ограничиваете каждый ровно тем, что нужно интеграции, и отзываете его по отдельности в любой момент.

Чтобы управлять токенами, перейдите в Настройки, Токены доступа. Кнопка Открыть документацию открывает полный справочник API в новой вкладке.

Лимиты токенов

  • Вы можете держать до 40 токенов доступа на магазин. Как только вы достигнете 40, кнопка Создать новый токен исчезнет, пока вы не удалите один.
  • Токены перечислены новейшими первыми, по 20 на страницу.

Создание токена

Нажмите Создать новый токен, заполните форму, затем нажмите Создать.

Название токена

  • Обязательно, до 50 символов.
  • Используется только для идентификации токена в вашем списке. Оно никогда не отправляется третьим сторонам.

Права

Выберите хотя бы одну из четырёх областей. Каждая независима, и API отклоняет любой запрос, область которого вы не выдали (ответ 403 "недостаточно прав" с указанием нужной области):

  • Чтение товаров: доступ к спискам товаров, деталям, вариантам и данным о наличии.
  • Чтение заказов: доступ к истории заказов, деталям, статусам и позициям.
  • Чтение вебхуков: просмотр списка и конфигураций ваших вебхуков.
  • Управление вебхуками: создание, обновление и удаление вебхуков.

Если ничего не выбрать, создание не пройдёт с сообщением "Выберите хотя бы одно право". Сами вебхуки настраиваются в Настройки, Вебхуки; эти области управляют только API-доступом к ним.

Доступ к данным

Это управляет тем, как далеко в прошлое токен может читать ваши данные. Выберите самый строгий вариант, который всё ещё работает.

  • Последние 24 часа (по умолчанию): токен видит только данные из скользящего 24-часового окна, пересчитываемого при каждом запросе. Самый безопасный, идеален для лент в реальном времени.
  • Задать дату начала: токен видит только данные, созданные в выбранную календарную дату или после неё. Выбор этого открывает выбор Даты начала доступа к данным.
  • За всё время: без ограничения по дате, токен читает всю историю. Используйте только когда интеграции это действительно нужно.

Истечение

  • Никогда не истекает (по умолчанию): действует, пока вы не удалите его.
  • Задать дату истечения: открывает выбор Даты истечения. Дата должна быть минимум на один день вперёд и не более чем на год от сегодняшнего дня. После её наступления токен автоматически перестаёт работать, и любой вызов API возвращает "токен доступа истёк".

Значение токена (показывается один раз)

После нажатия Создать значение токена (UUID) появляется один раз в сообщении об успехе. Сразу скопируйте и сохраните его в надёжном месте. Storeep больше никогда его не покажет и не сможет восстановить. Если вы его потеряете, удалите токен и создайте новый.

Использование токена с API

  • Отправляйте значение в HTTP-заголовке как Authorization: Bearer YOUR_TOKEN. Отсутствующий или некорректный заголовок возвращает ошибку 401.
  • Каждый токен ограничен 60 запросами за 60 секунд. Превышение возвращает ответ 429 "превышен лимит запросов", поэтому сбавьте темп и повторите после сброса окна.
  • Эндпоинты списков принимают фильтр market (один код страны или до 20), плюс limit (от 1 до 50, по умолчанию 20), page (по умолчанию 1) и сортировку по created_at или updated_at. См. Открыть документацию для URL эндпоинтов и полных деталей.

Редактирование токена

Нажмите на любую строку токена, чтобы изменить его название, права, режим доступа к данным и истечение. Вы не можете просмотреть или изменить само значение токена, редактирование лишь обновляет настройки, привязанные к существующему токену, поэтому интеграции продолжают работать без нового значения.

Столбцы списка токенов

  • Название: ярлык, который вы дали, с датой и временем создания ниже.
  • Права: выданные области (или Нет).
  • Доступ к данным: показывает Последние 24 часа, Все данные или С [даты].
  • Истечение: дата истечения или Никогда.
  • Последнее использование: дата и время последнего аутентифицированного вызова API токеном или Никогда.

Удаление токена

Выберите один или несколько токенов и нажмите Удалить токены или используйте действие удаления в строке. Удаление немедленное и окончательное: любая интеграция, всё ещё использующая это значение, сразу начинает получать ошибки аутентификации 401.

Советы по безопасности

  • Выдавайте только те области, которые интеграции действительно нужны.
  • Держите доступ к данным Последние 24 часа для живых лент и используйте Задать дату начала для плановых синхронизаций.
  • Задавайте дату истечения для краткосрочных подрядчиков или разовых задач.
  • Следите за столбцом Последнее использование: токен, который Никогда не использовался или давно бездействует, скорее всего относится к мёртвой интеграции, и его безопасно удалить.