Как получить токен доступа к API

Токен OAuth-приложения нужен интеграции, которая обращается к API Aplaut: виджетам 2.0, импорту и экспорту через Platform API, отправке отзывов через Submissions API. Выдаёт его Администратор в группе Админ → API и доступы.

Что понадобится

• Роль Администратор. Другим ролям группа API и доступы недоступна.
• Понимание, к каким API будет обращаться интеграция. Набор доступов у приложения после создания не меняется.

Шаг 1. Скопируйте Company ID для виджетов 2.0

Company ID — идентификатор компании в Aplaut, его спрашивают виджеты 2.0 и авторизация покупателей. Раньше он назывался Store ID. Интеграциям через Platform API и Submissions API он не нужен, для них переходите к шагу 2.

Откройте Админ → API и доступы → Токены аутентификации и в блоке Company ID нажмите значок копирования рядом со значением. Или откройте быстрые команды (Ctrl+K, на Mac Cmd+K) и выберите Скопировать ID компании.

Шаг 2. Создайте приложение OAuth

Заведите отдельное приложение под каждую интеграцию. Тогда токен одной интеграции можно отозвать, не останавливая остальные.

1. Откройте Админ → API и доступы → Приложения OAuth и нажмите Новое приложение.

2. В поле Название укажите, где будет работать токен, например «Отзывы на сайте».

3. В блоке Возможности отметьте API, к которым нужен доступ:

   Задача	Доступы
   Виджеты 2.0 на сайте	Content API и Submissions API
   Импорт и экспорт данных через Platform API v4	Platform API
   Отправка отзывов и вопросов из своих форм через Submissions API v2	Submissions API

4. Нажмите Сохранить. Откроется страница приложения.

Widgets API v2 работает только с легаси-токеном с экрана Админ → API и доступы → Токены аутентификации, OAuth-приложение для него не нужно. Все доступы, включая Merchant API, перечислены в справочнике группы «API и доступы».

Шаг 3. Сгенерируйте токен

1. На странице приложения в блоке Токены аутентификации нажмите Сгенерировать токен.
2. В окне Новый токен нажмите значок копирования и сохраните токен там, где его возьмёт интеграция.
3. Нажмите Закрыть.

warning

Полностью токен показывается один раз. После закрытия окна в списке остаются только шесть последних символов. Если токен не сохранён, сгенерируйте новый, а этот отзовите.

Токен действует 2 года. Дата окончания указана в строке токена в колонке Дата экспирации. Как передать токен в запросе, описано в справочнике группы «API и доступы».

Замените токен до истечения срока

Токен не продлевается. Замените его заранее: после даты экспирации API отвечает интеграции ошибкой 401.

1. В Админ → API и доступы → Приложения OAuth откройте приложение.
2. Нажмите Сгенерировать токен и сохраните новый токен, как в шаге 3.
3. Пропишите новый токен в интеграции и убедитесь, что она работает.
4. В строке старого токена откройте меню и выберите Отозвать.

Старый и новый токены работают одновременно, пока старый не отозван, поэтому интеграция переходит на новый токен без простоя. Отзыв срабатывает сразу и без подтверждения.

Удалите приложение, когда интеграция больше не нужна

1. Откройте приложение и отзовите все его токены.
2. Нажмите Удалить на странице приложения или в меню его строки в списке.
3. В диалоге Удалить приложение «…»? нажмите Удалить. Оставить закрывает диалог без удаления.

Приложение с действующими токенами не удаляется: кабинет покажет «Приложение не удалено: сначала отзовите все его токены». Отозванные и истёкшие токены удалению не мешают.

Если нужен другой набор доступов, создайте новое приложение, переведите интеграцию на его токен и удалите старое.

Смотрите также: роли и права доступа, как импортировать данные через Platform API, как настроить виджеты в личном кабинете.