Получение ключей через API в личном кабинете

Описание ситуации

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

Для создания API-ключа пользователь должен иметь роль «Администратор» для создания API-ключа.

Алгоритм действия

Чтобы пользователь мог запросить API-ключ ему необходимо авторизоваться / зарегистрироваться на платформе.
Далее пользователь должен проскроллить главную страницу вниз и перейти к разделу «Настройки».

Пример отображения раздела «Настройки» в личном кабинете

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

Пример отображения категория «Для разработчиков»

В развернувшемся окне пользователю нужно нажать на кнопку «Открыть» в левой верхней части экрана, чтобы открыть страницу с параметрами для создания API-ключа.

Пример отображения кнопки «Открыть»

Страница для создания API-ключа

Открыв новую страницу пользователь увидит пользователь увидит таблицу с полями и кнопки «Удалить все ключи» и «Создать ключ» в правой верхней части экрана.

Пример отображения страницы создания API-ключей

На странице создания API-ключа будут представлены следующие элементы:

• Кнопка «Удалить все ключи» — данная кнопка позволяет удалить все созданные API-ключи за одно нажатие. Для завершения процесса необходимо подтвердить удаление в модальном окне;
• Кнопка «Создать ключ» — кнопка открывает модальное окно создания API-ключа. Для завершения процесса необходимо заполнить поля и создать API-ключ;
• Чекбокс (галочка) выделения — позволяет сделать множественны выбор объектов (API-ключей) и взаимодействовать с ними;
• Имя ключа — поле, в котором будет отображаться имя ключа;
• Ключ — поле, в котором пользователь сможет увидеть последние 4 значения API-ключа;
• Дата создания — поле, в котором отображается дата создания API-ключа;
• Дата окончания — поле, в котором отображается дата, после которой API-ключ станет не действительным;
• Последнее использование — поле, в котором отображается дата, когда созданный API-ключ был использован для подключения;
• Иконка «Удалить» (мусорная корзина) — кнопка, позволяющая удалить выделенные API-ключи.

Пример отображения страницы с заполненными полями

Создание API-ключа

После нажатия на кнопку «Создать ключ» пользователю откроется модальное окно.

Пример отображения модального окна для создания API-ключа

В окне необходимо:

1. Придумать название для API-ключа.
2. Выбрать срок его действия с помощью календаря.

Пример отображения заполнения параметров создания API-ключа

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

Пример отображения процесса создания API-ключа

Рекомендуется прочитать описание к создаваемому ключу.

Пример отображения примечания

Особенности работы функционала

Данные функционал имеет определённый набор особенностей:

• При создании нескольких API-ключей нельзя использовать одно и тоже имя;
• Время жизни одного API-ключа — 1 год;
• Каждый созданный API-ключ является уникальным;
• После создания API-ключа, его обязательно нужно скопировать. Если пользователь не скопирует ключи и выйдет со страницы создания APi-ключей, то он более не сможет его нигде получить и скопировать;
• API-ключ перенимает и передает для подключения набор прав пользователя который его создал.

Видеоинструкция

Функционал видеоредактора

Дополнительная информация

Если данная статья не помогает использовать функционал по назначению или после ее прочтения остаются вопросы можно озвучить данные вопросы в разделе "Обсуждения" вверху страницы.

Пример отображения вкладки "Обсуждения" на wiki-странице

Также дополнительную информацию можно узнать на странице Как взаимодействовать пользователю с разделом "Обсуждения"