Все переводы

Материал из SmartPlayer

Введите имя сообщения для показа всех доступных переводов.

Сообщение

Найдено 2 перевода.

СообщениеТекущий текст
 ист. английский (en)== '''Description of the Situation''' ==
The SmartPlayer platform has added a feature that allows users to request an API key for integration through the personal account. This page explains how to correctly use this solution.
{{Note|To create an API key, the user must have the “Administrator” role.|warn}}
== '''Action Algorithm''' ==
To request an API key, the user must log in or register on the SmartPlayer platform.<br>
Next, the user should scroll down the main page and go to the “Settings” section.
[[File:Настройки раздел лк.png|thumb|center| Example of the “Settings” section in the personal account |800px]]
In the “Settings” section, the user must also scroll down and find the “For Developers” category and click on it.
[[File:Для разработчиков в настройки.png|thumb|center| Example of the “For Developers” category display |800px]]
In the expanded window, the user needs to click the “Open” button in the upper left part of the screen to open the page with parameters for creating an API key.
[[File:Кнопка_открыть.png|thumb|center| Example of the “Open” button |800px]]
== '''API Key Creation Page''' ==
After opening the new page, the user will see a table with fields and two buttons: “Delete all keys” and “Create key” in the upper right corner.
[[File:Кнопка_открыть.png|thumb|center| Example of the API key creation page |800px]]
The API key creation page includes the following elements:
* “Delete all keys” button — allows you to delete all created API keys at once. To complete the process, confirmation in a modal window is required;
* “Create key” button — opens the modal window for API key creation. To complete the process, fields must be filled and the key created;
* Selection checkbox — allows multiple API keys to be selected for batch actions;
* Key name — the field where the key's name is displayed;
* Key — the field where the user can see the last 4 characters of the API key;
* Creation date — the field displaying the API key creation date;
* Expiration date — the field displaying the date after which the API key becomes invalid;
* Last used — the field displaying the date the API key was last used for connection;
* “Delete” icon (trash can) — button to delete selected API keys.
[[File:Созданный_апиключ.png|thumb|center| Example of the page with filled-in fields |800px]]
=== '''Creating an API Key''' ===
After clicking the “Create key” button, the user will see a modal window.
[[File:Созданный_апиключ.png|thumb|center| Example of the modal window for API key creation |800px]]
In the window, the user must:
# Come up with a name for the API key.
# Select its expiration date using the calendar.
[[File:Создание_ключа.png|thumb|center| Example of filling out API key creation parameters |800px]]
Then the user must copy the key using the special icon (highlighted in the screenshot) and check the “I have copied the key” box. This step is mandatory to complete the process — otherwise the system will not allow further actions.
[[File:Завершение_создания_ключа.png|thumb|center| Example of the API key creation process |800px]]
{{Note|It is recommended to read the description of the created key.
[[File:Примечание_описание.png|thumb|center| Example of a note display |800px]]|warn}}
== '''Feature Details''' ==
This feature includes a set of specific characteristics:
* It is not allowed to use the same name for multiple API keys;
* The lifespan of one API key is 1 year;
* Each created API key is unique;
* After creating an API key, it must be copied. If the user does not copy the key and leaves the API key creation page, it will no longer be possible to retrieve or copy it;
* The API key inherits and passes along the set of permissions of the user who created it.
== '''Video Tutorial''' ==
[https://vk.com/video-227547238_456239078 Getting API Keys via the Personal Account]
== '''Additional Information''' ==
If this article does not help you use the feature as intended or you still have questions after reading it, you can ask them in the “Discussions” section at the top of the page.
[[File:Обсуждение_апи-ключ.png|thumb|center| Example of the “Discussions” tab on a wiki page |800px]]
You can also find more information on the page [[Как взаимодействовать пользователю с разделом "Обсуждения"]]
 ист. русский (ru)== '''Описание ситуации''' ==
В платформе SmartPlayer добавилась функциональность, позволяющая пользователю запросить API-ключ для интеграции через личный кабинет. На странице будет описано, как правильно использовать данное решение.
{{Note|Для создания API-ключа пользователь должен иметь роль «Администратор».|warn}}
== '''Алгоритм действия''' ==
Чтобы пользователь мог запросить API-ключ, ему необходимо авторизоваться / зарегистрироваться на платформе.<br>
Далее пользователь должен пролистать главную страницу вниз и перейти к разделу «Настройки».
[[File:Настройки раздел лк.png|thumb|center| Пример отображения раздела «Настройки» в личном кабинете |800px]]
В разделе «Настройки» пользователю также необходимо пролистать вниз и найти категорию «Для разработчиков», кликнув по ней.
[[File:Для разработчиков в настройки.png|thumb|center| Пример отображения категория «Для разработчиков»|800px]]
В развернувшемся окне пользователю нужно нажать на кнопку «Открыть» в левой верхней части экрана, чтобы открыть страницу с параметрами для создания API-ключа.
[[File:Кнопка_открыть.png|thumb|center| Пример отображения кнопки «Открыть» |800px]]
== '''Страница для создания API-ключа''' ==
Открыв новую страницу, пользователь увидит таблицу с полями и кнопки «Удалить все ключи» и «Создать ключ» в правой верхней части экрана.
[[File:Кнопка_открыть.png|thumb|center| Пример отображения страницы создания API-ключей |800px]]
На странице создания API-ключа будут представлены следующие элементы:
* Кнопка «Удалить все ключи» — данная кнопка позволяет удалить все созданные API-ключи за одно нажатие. Для завершения процесса необходимо подтвердить удаление в модальном окне;
* Кнопка «Создать ключ» — кнопка открывает модальное окно создания API-ключа. Для завершения процесса необходимо заполнить поля и создать API-ключ;
* Чекбокс (галочка) выделения — позволяет сделать множественный выбор объектов (API-ключей) и взаимодействовать с ними;
* Имя ключа — поле, в котором будет отображаться имя ключа;
* Ключ — поле, в котором пользователь сможет увидеть последние 4 значения API-ключа;
* Дата создания — поле, в котором отображается дата создания 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]]
Также дополнительную информацию можно узнать на странице [[Как взаимодействовать пользователю с разделом "Обсуждения"]]
Источник — https://wiki.smartplayer.org/index.php/Служебная:Переводы