Все переводы

Материал из SmartPlayer

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

Сообщение

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

СообщениеТекущий текст
 ист. английский (en)== '''Description of the Situation''' ==
For users who want to connect via REST API, it is recommended to use our dedicated resource. On this resource, the user can test methods and requests that allow connection and data retrieval from the SmartPlayer platform.
{{Note|'''The REST API portal is available [https://restapi.smartplayer.org/ here]. You can request authorization credentials (login and password) by contacting us via the [https://smartplayer.ru/ portal] or your assigned SmartPlayer specialist. You can also write to this [https://smartplayer.atlassian.net/servicedesk/customer/portal/1 email].''' |warn}}
== '''Portal Operation''' ==
This section is built on the Swagger Plugin and allows not only to ознакомиться with connection information for REST API, but also to test described methods and receive real results. Advanced users can also test these methods using Postman.
{{Note|'''Some methods described on the portal may not work correctly. The SmartPlayer team is aware of these issues and is working on fixing them.'''|warn}}
== '''Usage Scenario''' ==
It is assumed that interaction with the portal will follow a specific sequence. Usage scenario:
# Authorization on the portal.
# Selecting the required server for testing requests.
# Obtaining a token to use the "Authorize" button.
# Selecting the required method and reviewing its information. 
# Sending a request using the "Try it out" button.
# Receiving and reviewing the server response.
# Studying the "Schemas" section.
{{Note|Details are provided below on the page.|warn}}
== '''Information on the Portal''' ==
After authorization, the user will see the main page displaying the following information:
[[File:Стартовая_страница_портала.png|thumb|center| Example of the REST API portal main page |800px]]
The portal page includes information about:
* contact information for interacting with the SmartPlayer team;
* list of available servers for testing;
* "Authorize" button (details below);
* list of methods;
* "Schemas" section (scroll to the bottom of the page).
[[File:Разделение_страницы в апи.png|thumb|center| Example of portal page structure|800px]]
[[File:Раздел_schemas.png|thumb|center| Example of the "Schemas" section at the bottom |800px]]
== '''Server Selection''' ==
To test requests, the user must select one of the available servers. Each server is displayed as: "name" + "short description" (in English).
[[File:Списко_серверов.png|thumb|center| Example of available servers |800px]]
{{Note|The server list is not final. Users can connect manually via Postman to any server in the list or use other SmartPlayer servers such as "rc.smartplayer.org".|warn}}
== '''"Authorize" Button''' ==
Clicking the "Authorize" button opens a modal window where the user must enter a bearer token. Instructions for obtaining the token are provided via a link in the window.
[[File:Модальное окно для токенов.png|thumb|center| Example of authorization modal window |800px]]
After entering the token, click "Close". The authorization icon will change (lock icon will be closed and highlighted).
[[File:Иконка_авторизации.png|thumb|center| Example of authorization icon change |800px]]
{{Note|Hovering over the authorization icon will display an additional icon to copy the request to the clipboard.
[[File:Копировать_в_буфер_обмена.png|thumb|center| Example of copy-to-clipboard icon |800px]] |warn}}
== '''Methods Information''' ==
<div class="mw-collapsible mw-collapsed" style="border:1px solid #aaa; padding:8px; background:#f9f9f9;">
Currently, the portal provides two types of methods:
# GET — used to retrieve data. Parameters are passed via URL. Safe (idempotent) and cacheable. 
# POST — sends data in the request body. Used to create or modify resources. Suitable for sensitive data.
[[File:Пример_методов.png|thumb|center| Example of GET and POST methods |800px]]
Each method has an endpoint specified after the method name and highlighted in bold.
[[File:Конечная_точка.png|thumb|center| Example of endpoint display|800px]]
== '''Interaction with Methods''' ==
The list of methods allows users to test connections and retrieve sample data. A successful request returns method data and allows analysis of SmartPlayer behavior.
=== '''Method Areas''' ===
Methods are grouped by system areas:
* Authorization;
* Broadcast;
* Content;
* Notifications;
* IP-TV;
* User;
* Settings;
* Schedule;
* Devices
[[File:Список_методов.png|thumb|center| Example of method list |800px]]
{{Note|Each method includes a short English description.
[[File:Краткое_описание_метода.png|thumb|center| Example of method description|800px]]|warn}}
</div>
 ист. русский (ru)== '''Описание ситуации''' ==
Для пользователей, которые хотят подключиться по REST API рекомендуется использовать наш отдельный ресурс. На этом ресурсе пользователь опробует методы и запросы, которые позволят ему подключиться и получать данные от платформы SmartPlayer.
{{Note|'''Портал с поддержкой REST API расположен [https://restapi.smartplayer.org/ здесь]. Запросить данные для авторизации (логин и пароль) можно связавшись с нами через [https://smartplayer.ru/ портал] или прикрепленным специалистом компании SmartPlayer. Также можно написать на эту [https://smartplayer.atlassian.net/servicedesk/customer/portal/1 почту]''' |warn}}
== '''Работа портала''' ==
Данный раздел построен на базе Swagger Plugin и позволяет не только ознакомиться с информацией для подключения по REST API, но и опробовать описанные методы, получая реальный результат. Также технически продвинутые пользователи могут протестировать описанные методы, используя Postman.
{{Note|'''Некоторые методы, описанные на портале, могут отрабатывать некорректно. Команда SmartPlayer знает о проблемах и находится в процессе их устранения.'''|warn}}
== '''Сценарий использования''' ==
Предполагается, что взаимодействие с порталом будет происходить в определённой последовательности. Сценарий использования:
# Авторизация на портале.
# Выбор нужного сервера для тестирования запросов.
# Получение токена для использования кнопки "Authorize".
# Выбор нужного метода и изучение информации о нём. 
# По кнопке "Try it out" отправлять запрос.
# Получение и просмотр ответа от сервера.
# Изучение раздела "Schemas".
{{Note|Подробности будут изложены ниже на странице.|warn}}
== '''Информация на портале''' ==
После авторизации на портале пользователю откроется основная страница, на которой отобразится следующая информация:
[[File:Стартовая_страница_портала.png|thumb|center| Пример отображения главной страницы портала с REST API |800px]]
На странице портала отображается информация о:
* контактной информации о взаимодействии с командой SmartPlayer;
* списке доступных для тестирования серверов;
* кнопка "Authorize" (подробнее о работе с кнопкой ниже на странице);
* список методов;
* раздел "Schemas" (нужно пролистать страницу вниз до конца).
[[File:Разделение_страницы в апи.png|thumb|center| Пример отображения наполнения страницы портала|800px]]
[[File:Раздел_schemas.png|thumb|center| Пример отображения раздела "Schemas" в нижней части экрана |800px]]
== '''Выбор сервера''' ==
Для тестирования запросов с методами пользователю необходимо выбрать один из представленных в списке серверов. Каждый сервер из списка имеет формат отображения: "название" + "краткое описание" (на английском языке).
[[File:Списко_серверов.png|thumb|center| Пример отображения списка доступных серверов |800px]]
{{Note|Представленный список серверов не окончательный. Пользователь может с помощью Postman вручную подключиться к любому представленному из списка серверу, а также использовать другие сервера SmartPlayer. Например, "rc.smartplayer.org".|warn}}
== '''Кнопка "Atuhorize"''' ==
При нажатии на кнопку "Authorize" пользователю откроется модальное окно с описанием и полем, в котором необходимо указать токен (bearer token) для авторизации. Чтобы получить данный токен можно прочитать инструкцию, приложенную по ссылке в окне.
[[File:Модальное окно для токенов.png|thumb|center| Пример отображения модального окна для кнопки "Authorize" |800px]]
После введения токена авторизации необходимо нажать на кнопку "Close". Это вернёт пользователя на главную страницу, а также поменяет отображение иконки авторизации (выглядит как замок). Иконка будет подсвечена, а замок будет закрыт.
[[File:Иконка_авторизации.png|thumb|center| Пример отображения изменения иконки авторизации |800px]]
{{Note|При наведении на иконку авторизации интерфейс добавит ещё одну иконку, которая позволит скопировать запрос в буфер обмена.
[[File:Копировать_в_буфер_обмена.png|thumb|center| Пример отображения иконки копирования запроса в буфер обмена |800px]] |warn}}
== '''Информация о методах''' ==
<div class="mw-collapsible mw-collapsed" style="border:1px solid #aaa; padding:8px; background:#f9f9f9;">
На данный момент на портале представлено два вида методов:
# GET — используется для получения данных. Его параметры передаются в URL-ссылке. Метод безопасен (идемпотентен) и кэшируется. 
# POST — отправляет данные в теле запроса. Используется для создания или изменения ресурсов. Безопасен для конфиденциальной информации 
[[File:Пример_методов.png|thumb|center| Пример отображения методов GET и POST на странице |800px]]
Все методы представленные в списке имеют свою конечную точку пути (endpoint), который указывается после названия типа метода и выделяется жирным шрифтом.
[[File:Конечная_точка.png|thumb|center| Пример отображения конечной точки метода (endpoint)|800px]]
== '''Взаимодействие с методами''' ==
Список методов представленных на портале позволит пользователю провести тестовые подключения к серверам и получать с них примеры информации и данных передаваемых через запросы. Успешный запрос отдаст информацию по выбранному методу и пользователь сможет просмотреть полученные результаты, а также понять как реагирует платформа SmartPlayer.
=== '''Области работы методов''' ===
На портале представлены методы, работающие с различными частями системы. Ниже приведен список методов и область, с которой они взаимодействуют:
* авторизация (Authorization);
* трансляции (Broadcast);
* контент (Content);
* оповещения (Notifications);
* IP-телевидение (IP-TV);
* пользователь (User);
* настройки (Settings);
* расписания (Schedule);
* устройства (Devices)
[[File:Список_методов.png|thumb|center| Пример отображения списка доступных методов |800px]]
{{Note|Каждый из методов имеет небольшое описание на английском идущее после обозначения.
[[File:Краткое_описание_метода.png|thumb|center| Пример отображения описания метода|800px]]|warn}}
</div>
Источник — https://wiki.smartplayer.org/index.php?title=Служебная:Переводы