Подключение к внешнему REST API/en - История изменений

FuzzyBot: Обновление для соответствия новой версии исходной страницы.

2026-04-26T19:52:02Z

Обновление для соответствия новой версии исходной страницы.

← Предыдущая версия		Версия от 22:52, 26 апреля 2026
Строка 1:		Строка 1:
			<languages/>
	== '''Description of the Situation''' ==		== '''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.		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.

N.Bloshkin: Новая страница: «== '''Schemas''' ==
This section describes API data structures. 800px Schemas provide: # response formats; # request formats; # data types; # required fields; # nested structures; # reusable models; # error understanding. Expand sections via ">". File:Раздел_схемы.pn...»

2026-04-26T19:51:01Z

Новая страница: «== '''Schemas''' == <div class="mw-collapsible mw-collapsed" style="border:1px solid #aaa; padding:8px; background:#f9f9f9;"> This section describes API data structures. thumb|center| Example of "Schemas"|800px Schemas provide: # response formats; # request formats; # data types; # required fields; # nested structures; # reusable models; # error understanding. Expand sections via ">". File:Раздел_схемы.pn...»

← Предыдущая версия		Версия от 22:51, 26 апреля 2026
Строка 144:		Строка 144:
	[[File:Изменения.png\|thumb\|center\| Example of response display\|800px]]		[[File:Изменения.png\|thumb\|center\| Example of response display\|800px]]
	</div>		</div>
	~~<div lang="ru" dir="ltr" class="mw-content-ltr">~~		== '''Schemas''' ==
	== '''~~Схемы (~~Schemas)''' ==
	<div class="mw-collapsible mw-collapsed" style="border:1px solid #aaa; padding:8px; background:#f9f9f9;">		<div class="mw-collapsible mw-collapsed" style="border:1px solid #aaa; padding:8px; background:#f9f9f9;">
	~~Данный раздел описывает информацию о структуре данных, с которыми работает~~ API.		This section describes API data structures.
	[[File:Раздел_схемы.png\|thumb\|center\| ~~Пример отображения раздела~~ "Schemas"\|800px]]
	~~Понимание схемы данных даёт пользователю API~~:		[[File:Раздел_схемы.png\|thumb\|center\| Example of "Schemas"\|800px]]
	# ~~Понимание форматов ответа.~~
	# ~~Понимание форматов запроса.~~		Schemas provide:
	# ~~Типы данных.~~		# response formats;
	# ~~Обязательность полей.~~		# request formats;
	# ~~Понимание наличия/отсутствия вложенных структур.~~		# data types;
	# ~~Возможность повторного использования моделей.~~		# required fields;
	# ~~Понимание ошибок~~.		# nested structures;
	~~Чтобы развернуть любую вкладку раздела, пользователю нужно нажать на иконку~~ ">". ~~После открытия вкладки пользователь увидит два столбца:~~		# reusable models;
	* первый столбец — название параметра;		# error understanding.
	* второй столбец — тип данных параметра.
	[[File:Раздел_схемы.png\|thumb\|center\| ~~Пример отображения отображаемой информации на открытой вкладке~~\|800px]]		Expand sections via ">".
	~~В некоторых случаях под типом данных (во втором столбце) располагается описание или пример (example)~~.
	[[File:Опсание_или_пример.png\|thumb\|center\| ~~Пример отображения описания или примеров~~\|800px]]		[[File:Раздел_схемы.png\|thumb\|center\| Example of schema details\|800px]]
	Также присутствует ситуация, когда пользователь вместо типа данных получает ещё одну вкладку (название + ">"). Необходимо просто разворачивать доступные вкладки по иконке ">". Вложенностей такого формата может быть несколько.
	[[File:Вложенность_вкладок.png\|thumb\|center\| ~~Пример отображения вложенных вкладок~~\|800px]]		Some fields include descriptions or examples.

			[[File:Опсание_или_пример.png\|thumb\|center\| Example of descriptions\|800px]]

			Nested schemas are supported.

			[[File:Вложенность_вкладок.png\|thumb\|center\| Example of nested schemas\|800px]]
	</div>		</div>
	== '''~~Взаимодействие через~~ Postman''' ==
			== '''Postman Interaction''' ==
	<div class="mw-collapsible mw-collapsed" style="border:1px solid #aaa; padding:8px; background:#f9f9f9;">		<div class="mw-collapsible mw-collapsed" style="border:1px solid #aaa; padding:8px; background:#f9f9f9;">
	~~Для продвинутых пользователей доступен альтернативный вариант — обращение к ресурсам компании SmartPlayer через~~ Postman.~~<br>~~		Advanced users can use Postman.
	Установив и запустив Postman, пользователю необходимо нажать на кнопку "New" и выбрать вариант типа API. В данном случае это "HTTP" (он же REST).
	[[File:Новый_запрос_в_постман.png\|thumb\|center\| ~~Пример отображения интерфейса~~ Postman\|800px]]		Create request:
	После необходимо выбрать тип запроса из списка и вставить нужный URL-адрес (название сервера + /название конечной точки). В данном примере URL~~-адрес будет: https~~:~~//develop-api.smartplayer.org/login.~~		[[File:Новый_запрос_в_постман.png\|thumb\|center\| Example of Postman\|800px]]
	[[File:Вариант_запроса.png\|thumb\|center\| ~~Пример отображения тип запроса и URL-адреса~~\|800px]]
	Настроить параметры в разделе "Headers", по необходимости (параметры указаны на портале в теле метода) и тело запроса "Body" → "Raw" (если необходимо, также в теле описания метода на портале).		Set method and URL:
	[[File:Тело_запроса.png\|thumb\|center\| ~~Пример отображения "Headers" и "Body" → "Row"~~\|800px]]		[[File:Вариант_запроса.png\|thumb\|center\| Example of request setup\|800px]]
	{{Note\|~~Также в зависимости от запроса может понадобиться настроить авторизацию (раздел "~~Authorization~~" в Postman). Она реализована через "~~bearer token".\|warn}}
	~~Далее нажимаем на кнопку "Send" и моментально получаем ответ, который расположен в нижней части экрана.~~		Configure headers and body:
	~~[[File:Тело_ответа.png\|thumb\|center\| Пример отображения кнопки "~~Send~~" и ответа по запросу\|800px]]~~		[[File:Тело_запроса.png\|thumb\|center\| Example of headers and body\|800px]]
	~~Сравниваем его с информацией, указанной на портале.~~
	~~</div>~~		{{Note\|Authorization may be required via bearer token.\|warn}}
	~~== '''Видеоинструкция''' ==~~
	~~[https~~:~~//vkvideo.ru/video-227547238_456239131 Подключение к внешнему REST API]~~		Send request:
	~~== '''Дополнительная информация''' ==~~		[[File:Тело_ответа.png\|thumb\|center\| Example of response\|800px]]
	Если данная статья не помогает использовать функционал по назначению или после её прочтения остаются вопросы, их можно задать в разделе "Обсуждения" вверху страницы.
	[[File:~~Обсуждение_подключения_~~.png\|thumb\|center\| ~~Пример отображения вкладки "Обсуждения" на wiki-странице~~ \|800px]]
	Найти дополнительную информацию можно на странице [[Как взаимодействовать пользователю с разделом "Обсуждения"]]
	</div>		</div>

			== '''Video Instruction''' ==
			[https://vkvideo.ru/video-227547238_456239131 Connecting to external REST API]

			== '''Additional Information''' ==
			If this article does not help, questions can be asked in the “Discussions” section.

			[[File:Обсуждение_подключения_.png\|thumb\|center\| Example of discussions tab\|800px]]

			Additional information: [[How to interact with the "Discussions" section]]

N.Bloshkin: Новая страница: «=== '''Methods List''' ===
Below is a list of methods with translated descriptions: * Authorization: ** Login to the server application. 800px * Broadcast: Import broadcast. Send event to change broadcast page. Get all broadcasts. Get broadcast by I...»

2026-04-26T19:50:01Z

Новая страница: «=== '''Methods List''' === <div class="mw-collapsible mw-collapsed" style="border:1px solid #aaa; padding:8px; background:#f9f9f9;"> Below is a list of methods with translated descriptions: * Authorization: ** Login to the server application. thumb|center| Example of authorization method|800px * Broadcast: ** Import broadcast. ** Send event to change broadcast page. ** Get all broadcasts. ** Get broadcast by I...»

Новая страница

== '''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>
=== '''Methods List''' ===
<div class="mw-collapsible mw-collapsed" style="border:1px solid #aaa; padding:8px; background:#f9f9f9;">
Below is a list of methods with translated descriptions:

* Authorization:
** Login to the server application.
[[File:Метод_авторизации.png|thumb|center| Example of authorization method|800px]]

* Broadcast:
** Import broadcast.
** Send event to change broadcast page.
** Get all broadcasts.
** Get broadcast by ID.
** Get broadcast by title.
[[File:Метод_трансляций.png|thumb|center| Example of broadcast methods|800px]]

* Content:
** Upload file.
** Upload multiple files.
** Upload file to video editor.
** Upload files.
[[File:Метод_контента.png|thumb|center| Example of content methods|800px]]

* Notifications:
** Upload user activity history.
[[File:Метод_оповещений.png|thumb|center| Example of notification method|800px]]

* IP-TV:
** Export CSV files.
** Import CSV files.
[[File:Методы_иптв.png|thumb|center| Example of IPTV methods|800px]]

* User:
** Update user photo.
** Create user.
** Send password reset link.
[[File:Методы_пользователя.png|thumb|center| Example of user methods|800px]]

* Settings:
** Upload font.
[[File:Методы_настроек.png|thumb|center| Example of settings method|800px]]

* Schedule:
** Export schedule archive.
[[File:Методы_расписания.png|thumb|center| Example of schedule method|800px]]

* Devices:
** Get device by IP.
** Get all devices.
** Update timers.
[[File:Методы_устройства.png|thumb|center| Example of device methods|800px]]
</div>

=== '''Method Details''' ===
<div class="mw-collapsible mw-collapsed" style="border:1px solid #aaa; padding:8px; background:#f9f9f9;">
Each method can be expanded to view:
* description;
* parameters;
* request body;
* responses.

[[File:Данные_во_вкладке_метода.png|thumb|center| Example of method details|800px]]

=== '''"Try it out" Button''' ===
Allows sending requests.

[[File:Кнопка попробовать.png|thumb|center| Example of "Try it out"|800px]]

After activation:
* interface changes;
* button becomes "Cancel".

[[File:Изменение_интерфейса.png|thumb|center| Example of interface change|800px]]

Send request via "Execute".

[[File:Кнопка_отправки_запроса.png|thumb|center| Example of "Execute"|800px]]

Response appears in "Responses".

[[File:Изменения.png|thumb|center| Example of response display|800px]]
</div>
<div lang="ru" dir="ltr" class="mw-content-ltr">
== '''Схемы (Schemas)''' ==
<div class="mw-collapsible mw-collapsed" style="border:1px solid #aaa; padding:8px; background:#f9f9f9;">
Данный раздел описывает информацию о структуре данных, с которыми работает API.
[[File:Раздел_схемы.png|thumb|center| Пример отображения раздела "Schemas"|800px]]
Понимание схемы данных даёт пользователю API:
# Понимание форматов ответа.
# Понимание форматов запроса.
# Типы данных.
# Обязательность полей.
# Понимание наличия/отсутствия вложенных структур.
# Возможность повторного использования моделей.
# Понимание ошибок.
Чтобы развернуть любую вкладку раздела, пользователю нужно нажать на иконку ">". После открытия вкладки пользователь увидит два столбца:
* первый столбец — название параметра;
* второй столбец — тип данных параметра.
[[File:Раздел_схемы.png|thumb|center| Пример отображения отображаемой информации на открытой вкладке|800px]]
В некоторых случаях под типом данных (во втором столбце) располагается описание или пример (example).
[[File:Опсание_или_пример.png|thumb|center| Пример отображения описания или примеров|800px]]
Также присутствует ситуация, когда пользователь вместо типа данных получает ещё одну вкладку (название + ">"). Необходимо просто разворачивать доступные вкладки по иконке ">". Вложенностей такого формата может быть несколько.
[[File:Вложенность_вкладок.png|thumb|center| Пример отображения вложенных вкладок|800px]]
</div>
== '''Взаимодействие через Postman''' ==
<div class="mw-collapsible mw-collapsed" style="border:1px solid #aaa; padding:8px; background:#f9f9f9;">
Для продвинутых пользователей доступен альтернативный вариант — обращение к ресурсам компании SmartPlayer через Postman.<br>
Установив и запустив Postman, пользователю необходимо нажать на кнопку "New" и выбрать вариант типа API. В данном случае это "HTTP" (он же REST).
[[File:Новый_запрос_в_постман.png|thumb|center| Пример отображения интерфейса Postman|800px]]
После необходимо выбрать тип запроса из списка и вставить нужный URL-адрес (название сервера + /название конечной точки). В данном примере URL-адрес будет: https://develop-api.smartplayer.org/login.
[[File:Вариант_запроса.png|thumb|center| Пример отображения тип запроса и URL-адреса|800px]]
Настроить параметры в разделе "Headers", по необходимости (параметры указаны на портале в теле метода) и тело запроса "Body" → "Raw" (если необходимо, также в теле описания метода на портале).
[[File:Тело_запроса.png|thumb|center| Пример отображения "Headers" и "Body" → "Row"|800px]]
{{Note|Также в зависимости от запроса может понадобиться настроить авторизацию (раздел "Authorization" в Postman). Она реализована через "bearer token".|warn}}
Далее нажимаем на кнопку "Send" и моментально получаем ответ, который расположен в нижней части экрана.
[[File:Тело_ответа.png|thumb|center| Пример отображения кнопки "Send" и ответа по запросу|800px]]
Сравниваем его с информацией, указанной на портале.
</div>
== '''Видеоинструкция''' ==
[https://vkvideo.ru/video-227547238_456239131 Подключение к внешнему REST API]
== '''Дополнительная информация''' ==
Если данная статья не помогает использовать функционал по назначению или после её прочтения остаются вопросы, их можно задать в разделе "Обсуждения" вверху страницы.
[[File:Обсуждение_подключения_.png|thumb|center| Пример отображения вкладки "Обсуждения" на wiki-странице |800px]]
Найти дополнительную информацию можно на странице [[Как взаимодействовать пользователю с разделом "Обсуждения"]]
</div>