Новая страница: «== '''Описание ситуации''' == В платформе SmartPlayer добавилась функциональность позволяющая пользователю запросить API-ключ для интеграции через личный кабинет. На странице будет описано как правильно использовать данное решение. {{Note||warn}} == '''Алгоритм действи...»
(не показано 5 промежуточных версий этого же участника)
Строка 1:
Строка 1:
<languages/>
<translate>
<!--T:1-->
== '''Описание ситуации''' ==
== '''Описание ситуации''' ==
В платформе SmartPlayer добавилась функциональность позволяющая пользователю запросить API-ключ для интеграции через личный кабинет. На странице будет описано как правильно использовать данное решение.
В платформе SmartPlayer добавилась функциональность, позволяющая пользователю запросить API-ключ для интеграции через личный кабинет. На странице будет описано, как правильно использовать данное решение.
{{Note||warn}}
{{Note|Для создания API-ключа пользователь должен иметь роль «Администратор».|warn}}
== '''Алгоритм действия''' ==
== '''Алгоритм действия''' ==
Чтобы пользователь мог запросить API-ключ ему необходимо авторизоваться / зарегистрироваться на платформе.<br>
Чтобы пользователь мог запросить API-ключ, ему необходимо авторизоваться / зарегистрироваться на платформе.<br>
Далее пользователь должен проскроллить главную страницу вниз и перейти к разделу «Настройки».
Далее пользователь должен пролистать главную страницу вниз и перейти к разделу «Настройки».
[[File:Обсуждение_лицензий.png|thumb|center| Пример отображения вкладки "Обсуждения" на wiki-странице |800px]]
[[File:Настройки раздел лк.png|thumb|center| Пример отображения раздела «Настройки» в личном кабинете |800px]]
В разделе «Настройки» пользователю необходимо найти категорию «Для разработчиков» и кликнуть на неё.
В разделе «Настройки» пользователю также необходимо пролистать вниз и найти категорию «Для разработчиков», кликнув по ней.
[[File:Обсуждение_лицензий.png|thumb|center| Пример отображения вкладки "Обсуждения" на wiki-странице |800px]]
[[File:Для разработчиков в настройки.png|thumb|center| Пример отображения категория «Для разработчиков»|800px]]
В развернувшемся окне пользователю нужно нажать на кнопку «Открыть» в левой верхней части экрана, чтобы открыть страницу с параметрами для создания API-ключа.
В развернувшемся окне пользователю нужно нажать на кнопку «Открыть» в левой верхней части экрана, чтобы открыть страницу с параметрами для создания API-ключа.
[[File:Обсуждение_лицензий.png|thumb|center| Пример отображения вкладки "Обсуждения" на wiki-странице |800px]]
[[File:Кнопка_открыть.png|thumb|center| Пример отображения кнопки «Открыть» |800px]]
== '''Создание API-ключа''' ==
== '''Страница для создания API-ключа''' ==
Открыв новую страницу, пользователь увидит таблицу с полями и кнопки «Удалить все ключи» и «Создать ключ» в правой верхней части экрана.
[[File:Кнопка_открыть.png|thumb|center| Пример отображения страницы создания API-ключей |800px]]
На странице создания API-ключа будут представлены следующие элементы:
* Кнопка «Удалить все ключи» — данная кнопка позволяет удалить все созданные API-ключи за одно нажатие. Для завершения процесса необходимо подтвердить удаление в модальном окне;
* Кнопка «Создать ключ» — кнопка открывает модальное окно создания API-ключа. Для завершения процесса необходимо заполнить поля и создать API-ключ;
* Чекбокс (галочка) выделения — позволяет сделать множественный выбор объектов (API-ключей) и взаимодействовать с ними;
* Имя ключа — поле, в котором будет отображаться имя ключа;
* Ключ — поле, в котором пользователь сможет увидеть последние 4 значения API-ключа;
* Дата создания — поле, в котором отображается дата создания API-ключа;
* Дата окончания — поле, в котором отображается дата, после которой API-ключ станет недействительным;
* Последнее использование — поле, в котором отображается дата, когда созданный API-ключ был использован для подключения;
[[File:Созданный_апиключ.png|thumb|center| Пример отображения страницы с заполненными полями |800px]]
=== '''Создание API-ключа''' ===
После нажатия на кнопку «Создать ключ» пользователю откроется модальное окно.
[[File:Созданный_апиключ.png|thumb|center| Пример отображения модального окна для создания API-ключа |800px]]
В окне необходимо:
# Придумать название для API-ключа.
# Выбрать срок его действия с помощью календаря.
[[File:Создание_ключа.png|thumb|center| Пример отображения заполнения параметров создания API-ключа|800px]]
Далее пользователь должен скопировать сам ключ с помощью специальной иконки (выделена на скриншоте) и поставить чекбокс (галочку) «Я скопировал ключ». Данное действие обязательно для завершения процесса создания ключа, иначе система не даст сделать других действий.
[[File:Завершение_создания_ключа.png|thumb|center| Пример отображения процесса создания API-ключа|800px]]
{{Note|Рекомендуется прочитать описание к создаваемому ключу.
[[File:Примечание_описание.png|thumb|center| Пример отображения примечания|800px]]|warn}}
== '''Особенности работы функционала''' ==
Функционал имеет определённый набор особенностей:
* При создании нескольких API-ключей нельзя использовать одно и то же имя;
* Время жизни одного API-ключа — 1 год;
* Каждый созданный API-ключ является уникальным;
* После создания API-ключа, его обязательно нужно скопировать. Если пользователь не скопирует ключи и выйдет со страницы создания API-ключей, то он более не сможет его нигде получить и скопировать;
* API-ключ перенимает и передает для подключения набор прав пользователя, который его создал.
[https://vk.com/video-227547238_456239078 Получение ключей через API в личном кабинете]
== '''Дополнительная информация''' ==
== '''Дополнительная информация''' ==
Если данная статья не помогает использовать функционал по назначению или после ее прочтения остаются вопросы можно озвучить данные вопросы в разделе "Обсуждения" вверху страницы.
Если данная статья не помогает использовать функционал по назначению или после ее прочтения остаются вопросы можно озвучить данные вопросы в разделе "Обсуждения" вверху страницы.
[[File:Обсуждение_лицензий.png|thumb|center| Пример отображения вкладки "Обсуждения" на wiki-странице |800px]]
[[File:Обсуждение_апи-ключ.png|thumb|center| Пример отображения вкладки "Обсуждения" на wiki-странице |800px]]
Также дополнительную информацию можно узнать на странице [[Как взаимодействовать пользователю с разделом "Обсуждения"]]
Также дополнительную информацию можно узнать на странице [[Как взаимодействовать пользователю с разделом "Обсуждения"]]
В платформе SmartPlayer добавилась функциональность, позволяющая пользователю запросить API-ключ для интеграции через личный кабинет. На странице будет описано, как правильно использовать данное решение.
Для создания API-ключа пользователь должен иметь роль «Администратор».
Алгоритм действия
Чтобы пользователь мог запросить API-ключ, ему необходимо авторизоваться / зарегистрироваться на платформе.
Далее пользователь должен пролистать главную страницу вниз и перейти к разделу «Настройки».
Пример отображения раздела «Настройки» в личном кабинете
В разделе «Настройки» пользователю также необходимо пролистать вниз и найти категорию «Для разработчиков», кликнув по ней.
Пример отображения категория «Для разработчиков»
В развернувшемся окне пользователю нужно нажать на кнопку «Открыть» в левой верхней части экрана, чтобы открыть страницу с параметрами для создания API-ключа.
Пример отображения кнопки «Открыть»
Страница для создания API-ключа
Открыв новую страницу, пользователь увидит таблицу с полями и кнопки «Удалить все ключи» и «Создать ключ» в правой верхней части экрана.
Пример отображения страницы создания API-ключей
На странице создания API-ключа будут представлены следующие элементы:
Кнопка «Удалить все ключи» — данная кнопка позволяет удалить все созданные API-ключи за одно нажатие. Для завершения процесса необходимо подтвердить удаление в модальном окне;
Кнопка «Создать ключ» — кнопка открывает модальное окно создания API-ключа. Для завершения процесса необходимо заполнить поля и создать API-ключ;
Чекбокс (галочка) выделения — позволяет сделать множественный выбор объектов (API-ключей) и взаимодействовать с ними;
Имя ключа — поле, в котором будет отображаться имя ключа;
Ключ — поле, в котором пользователь сможет увидеть последние 4 значения API-ключа;
Дата создания — поле, в котором отображается дата создания API-ключа;
Дата окончания — поле, в котором отображается дата, после которой API-ключ станет недействительным;
Последнее использование — поле, в котором отображается дата, когда созданный API-ключ был использован для подключения;
После нажатия на кнопку «Создать ключ» пользователю откроется модальное окно.
Пример отображения модального окна для создания API-ключа
В окне необходимо:
Придумать название для API-ключа.
Выбрать срок его действия с помощью календаря.
Пример отображения заполнения параметров создания API-ключа
Далее пользователь должен скопировать сам ключ с помощью специальной иконки (выделена на скриншоте) и поставить чекбокс (галочку) «Я скопировал ключ». Данное действие обязательно для завершения процесса создания ключа, иначе система не даст сделать других действий.
Пример отображения процесса создания API-ключа
Рекомендуется прочитать описание к создаваемому ключу.
Пример отображения примечания
Особенности работы функционала
Функционал имеет определённый набор особенностей:
При создании нескольких API-ключей нельзя использовать одно и то же имя;
Время жизни одного API-ключа — 1 год;
Каждый созданный API-ключ является уникальным;
После создания API-ключа, его обязательно нужно скопировать. Если пользователь не скопирует ключи и выйдет со страницы создания API-ключей, то он более не сможет его нигде получить и скопировать;
API-ключ перенимает и передает для подключения набор прав пользователя, который его создал.
Если данная статья не помогает использовать функционал по назначению или после ее прочтения остаются вопросы можно озвучить данные вопросы в разделе "Обсуждения" вверху страницы.
Пример отображения вкладки "Обсуждения" на wiki-странице
