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

N.Bloshkin в 19:50, 26 апреля 2026

2026-04-26T19:50:57Z

← Предыдущая версия		Версия от 22:50, 26 апреля 2026
Строка 1:		Строка 1:
	</~~languages~~>		<languages/>
	<translate>		<translate>
	<!--T:1-->		<!--T:1-->

N.Bloshkin в 19:50, 26 апреля 2026

2026-04-26T19:50:46Z

← Предыдущая версия		Версия от 22:50, 26 апреля 2026
Строка 1:		Строка 1:
			</languages>
	<translate>		<translate>
	<!--T:1-->		<!--T:1-->

N.Bloshkin: Отметить эту версию для перевода

2026-04-26T19:48:09Z

Отметить эту версию для перевода

← Предыдущая версия		Версия от 22:48, 26 апреля 2026
Строка 1:		Строка 1:
	<translate>		<translate>
			<!--T:1-->
	== '''Описание ситуации''' ==		== '''Описание ситуации''' ==
	Для пользователей, которые хотят подключиться по REST API рекомендуется использовать наш отдельный ресурс. На этом ресурсе пользователь опробует методы и запросы, которые позволят ему подключиться и получать данные от платформы SmartPlayer.		Для пользователей, которые хотят подключиться по REST API рекомендуется использовать наш отдельный ресурс. На этом ресурсе пользователь опробует методы и запросы, которые позволят ему подключиться и получать данные от платформы SmartPlayer.
Строка 65:		Строка 66:
	</translate>		</translate>
	<translate>		<translate>
			<!--T:2-->
	=== '''Список методов''' ===		=== '''Список методов''' ===
	<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;">
Строка 128:		Строка 130:
	</translate>		</translate>
	<translate>		<translate>
			<!--T:3-->
	== '''Схемы (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;">

N.Bloshkin в 19:45, 26 апреля 2026

2026-04-26T19:45:11Z

Внесённые изменения

N.Bloshkin в 18:56, 26 апреля 2026

2026-04-26T18:56:32Z

← Предыдущая версия		Версия от 21:56, 26 апреля 2026
Строка 38:		Строка 38:
	[[File:Копировать_в_буфер_обмена.png\|thumb\|center\| Пример отображения иконки копирования запроса в буфер обмена \|800px]] \|warn}}		[[File:Копировать_в_буфер_обмена.png\|thumb\|center\| Пример отображения иконки копирования запроса в буфер обмена \|800px]] \|warn}}
	== '''Информация о методах''' ==		== '''Информация о методах''' ==
			<div class="mw-collapsible mw-collapsed" style="border:1px solid #aaa; padding:8px; background:#f9f9f9;">
	На данный момент на портале представлено два вида методов:		На данный момент на портале представлено два вида методов:
	# GET — используется для получения данных. Его параметры передаются в URL-ссылке. Метод безопасен (идемпотентен) и кэшируется.		# GET — используется для получения данных. Его параметры передаются в URL-ссылке. Метод безопасен (идемпотентен) и кэшируется.
Строка 60:		Строка 61:
	{{Note\|Каждый из методов имеет небольшое описание на английском идущие после обозначения.		{{Note\|Каждый из методов имеет небольшое описание на английском идущие после обозначения.
	[[File:Краткое_описание_метода.png\|thumb\|center\| Пример отображения описания метода\|800px]]\|warn}}		[[File:Краткое_описание_метода.png\|thumb\|center\| Пример отображения описания метода\|800px]]\|warn}}
			</div>
	=== '''Список методов''' ===		=== '''Список методов''' ===
			<div class="mw-collapsible mw-collapsed" style="border:1px solid #aaa; padding:8px; background:#f9f9f9;">
	Ниже будет представлен список методов с переводом краткого описания в порядке описанном ранее:		Ниже будет представлен список методов с переводом краткого описания в порядке описанном ранее:
	* Авторизация:		* Авторизация:
Строка 101:		Строка 104:
	** Обновить таймеры digital signage		** Обновить таймеры digital signage
	[[File:Методы_устройства.png\|thumb\|center\| Пример отображения доступного метода для устройств\|800px]]		[[File:Методы_устройства.png\|thumb\|center\| Пример отображения доступного метода для устройств\|800px]]
			</div>
	=== '''Информация внутри метода''' ===		=== '''Информация внутри метода''' ===
			<div class="mw-collapsible mw-collapsed" style="border:1px solid #aaa; padding:8px; background:#f9f9f9;">
	Каждый метод можно развернуть по иконке ">" и просмотреть его содержимое. Внутри метода отображается следующая информация:		Каждый метод можно развернуть по иконке ">" и просмотреть его содержимое. Внутри метода отображается следующая информация:
	* краткое описание метода (на английском);		* краткое описание метода (на английском);
Строка 117:		Строка 122:
	Ответ будет отображён в разделе "Responses". Запрос можно повторить снова нажав кнопку "Execute" и введя другой параметр. Или очистить содержимое запроса нажав на кнопку "Clear".		Ответ будет отображён в разделе "Responses". Запрос можно повторить снова нажав кнопку "Execute" и введя другой параметр. Или очистить содержимое запроса нажав на кнопку "Clear".
	[[File:Изменения.png\|thumb\|center\| Пример отображения ответа и изменения интерфейса после запроса к серверу\|800px]]		[[File:Изменения.png\|thumb\|center\| Пример отображения ответа и изменения интерфейса после запроса к серверу\|800px]]
			</div>
	== '''Схемы (Schemas)''' ==		== '''Схемы (Schemas)''' ==
			<div class="mw-collapsible mw-collapsed" style="border:1px solid #aaa; padding:8px; background:#f9f9f9;">
	Данный раздел описывает информацию о структуре данных, с которыми работает API.		Данный раздел описывает информацию о структуре данных, с которыми работает API.
	[[File:Раздел_схемы.png\|thumb\|center\| Пример отображения раздела "Schemas"\|800px]]		[[File:Раздел_схемы.png\|thumb\|center\| Пример отображения раздела "Schemas"\|800px]]
Строка 136:		Строка 143:
	Также присутствует ситуация, когда пользователь вместо типа данных получает еще одну вкладку (называние + ">"). Необходимо просто разворачивать доступные вкладки по иконке ">". Вложенностей такого формата может быть несколько.		Также присутствует ситуация, когда пользователь вместо типа данных получает еще одну вкладку (называние + ">"). Необходимо просто разворачивать доступные вкладки по иконке ">". Вложенностей такого формата может быть несколько.
	[[File:Вложенность_вкладок.png\|thumb\|center\| Пример отображения вложенных вкладок\|800px]]		[[File:Вложенность_вкладок.png\|thumb\|center\| Пример отображения вложенных вкладок\|800px]]
			</div>
	== '''Взаимодействие через Postman''' ==		== '''Взаимодействие через Postman''' ==
			<div class="mw-collapsible mw-collapsed" style="border:1px solid #aaa; padding:8px; background:#f9f9f9;">
	Для продвинутых пользователей доступен альтернативный вариант — обращение к ресурсам компании SmartPlayer через Postman.<br>		Для продвинутых пользователей доступен альтернативный вариант — обращение к ресурсам компании SmartPlayer через Postman.<br>
	Установив и запустив Postman пользователю необходимо нажать на кнопку "New" и выбрать вариант типа API. В данном случае это "HTTP" (он же REST).		Установив и запустив Postman пользователю необходимо нажать на кнопку "New" и выбрать вариант типа API. В данном случае это "HTTP" (он же REST).
Строка 148:		Строка 157:
	[[File:Тело_ответа.png\|thumb\|center\| Пример отображения кнопки "Send" и ответа по запросу\|800px]]		[[File:Тело_ответа.png\|thumb\|center\| Пример отображения кнопки "Send" и ответа по запросу\|800px]]
	Сравниваем его с информацией указанной на портале.		Сравниваем его с информацией указанной на портале.
			</div>
	== '''Видеоинструкция''' ==		== '''Видеоинструкция''' ==
	[https://vkvideo.ru/video-~~227547238_456239130~~ Подключение к внешнему REST API]		[https://vkvideo.ru/video-227547238_456239131 Подключение к внешнему REST API]
	== '''Дополнительная информация''' ==		== '''Дополнительная информация''' ==
	Если данная статья не помогает использовать функционал по назначению или после её прочтения остаются вопросы, их можно задать в разделе "Обсуждения" вверху страницы.		Если данная статья не помогает использовать функционал по назначению или после её прочтения остаются вопросы, их можно задать в разделе "Обсуждения" вверху страницы.
	[[File:Обсуждение_подключения_.png\|thumb\|center\| Пример отображения вкладки "Обсуждения" на wiki-странице \|800px]]		[[File:Обсуждение_подключения_.png\|thumb\|center\| Пример отображения вкладки "Обсуждения" на wiki-странице \|800px]]
	Найти дополнительную информацию можно на странице [[Как взаимодействовать пользователю с разделом "Обсуждения"]]		Найти дополнительную информацию можно на странице [[Как взаимодействовать пользователю с разделом "Обсуждения"]]

N.Bloshkin в 18:45, 26 апреля 2026

2026-04-26T18:45:33Z

← Предыдущая версия		Версия от 21:45, 26 апреля 2026
Строка 138:		Строка 138:
	== '''Взаимодействие через Postman''' ==		== '''Взаимодействие через Postman''' ==
	Для продвинутых пользователей доступен альтернативный вариант — обращение к ресурсам компании SmartPlayer через Postman.<br>		Для продвинутых пользователей доступен альтернативный вариант — обращение к ресурсам компании SmartPlayer через Postman.<br>
	Установив и запустив Postman пользователю необходимо выбрать ~~сервер, к которому~~ он ~~будет обращаться~~ и ~~прописать~~ (~~скопировать~~) ~~его~~ URL-адрес.		Установив и запустив 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" → "Row" (если необходимо, также в теле описания метода на портале).
			[[File:Тело_запроса.png\|thumb\|center\| Пример отображения "Headers" и "Body" → "Row"\|800px]]
			{{Note\|Также в зависимости от запроса может понадобиться настроить авторизацию (раздел "Authorization" в Postman). Она реализована через "bearer token".\|warn}}
			Далее нажимаем на кнопку "Send" и моментально получаем ответ, который расположен в нижней части экрана.
			[[File:Тело_ответа.png\|thumb\|center\| Пример отображения кнопки "Send" и ответа по запросу\|800px]]
			Сравниваем его с информацией указанной на портале.
	== '''Видеоинструкция''' ==		== '''Видеоинструкция''' ==
	[https://vkvideo.ru/video-227547238_456239130 Подключение к внешнему REST API]		[https://vkvideo.ru/video-227547238_456239130 Подключение к внешнему REST API]

N.Bloshkin в 18:10, 26 апреля 2026

2026-04-26T18:10:01Z

← Предыдущая версия		Версия от 21:10, 26 апреля 2026
Строка 45:		Строка 45:
	[[File:Конечная_точка.png\|thumb\|center\| Пример отображения конечной точки метода (endpoint)\|800px]]		[[File:Конечная_точка.png\|thumb\|center\| Пример отображения конечной точки метода (endpoint)\|800px]]
	== '''Взаимодействие с методами''' ==		== '''Взаимодействие с методами''' ==
			Список методов представленных на портале позволит пользователю провести тестовые подключения к северам и получать с них примеры информации и данных передаваемых через запросы. Успешный запрос отдаст информацию по выбранному методу и пользователь сможет просмотреть полученные результаты и понять как реагирует платформа SmartPlayer.
	=== '''Области работы методов''' ===		=== '''Области работы методов''' ===
	На портале представлены методы работающие с различными частями системы. Ниже приведен список методов и область с которой они взаимодействуют:		На портале представлены методы работающие с различными частями системы. Ниже приведен список методов и область с которой они взаимодействуют:
Строка 107:		Строка 107:
	* тело запроса (Request body), с возможность просмотра примера значений (Example Values) или схемы (Schema);		* тело запроса (Request body), с возможность просмотра примера значений (Example Values) или схемы (Schema);
	* ответы (Responses) с кодами ответов.		* ответы (Responses) с кодами ответов.
			[[File:Данные_во_вкладке_метода.png\|thumb\|center\| Пример отображения содержания методов\|800px]]
	=== '''Кнопка "Try"it out''' ===		=== '''Кнопка "Try"it out''' ===
	Кнопка "Try it out" позволяет пользователю попробовать сделать запрос к любому выбранному ранее серверу.		Кнопка "Try it out" (попробуйте это) позволяет пользователю попробовать сделать запрос к любому выбранному ранее серверу.
			[[File:Кнопка попробовать.png\|thumb\|center\| Пример отображения кнопки "Try it out" \|800px]]
	При ее нажатии интерфейс немного меняется предлагая пользователю либо тело запроса, либо строку для ввода значения параметра.		При ее нажатии интерфейс немного меняется предлагая пользователю либо тело запроса, либо строку для ввода значения параметра. Кнопка "Try it out" меняется на кнопку "Cancel" (удалить), которая возвращает метод в исходное состояние.
			[[File:Изменение_интерфейса.png\|thumb\|center\| Пример отображения изменений интерфейса\|800px]]
	Отправить запрос можно кликнув по кнопке "Execute". Ответ приходит сразу же по нажатию.		Отправить запрос можно кликнув по кнопке "Execute". Ответ приходит сразу же по нажатию.
			[[File:Кнопка_отправки_запроса.png\|thumb\|center\| Пример отображения кнопки "Execute"\|800px]]
	Запрос можно повторить снова нажав кнопку "Execute" и введя другой параметр. Или очистить содержимое запроса нажав на кнопку "Clear".		Ответ будет отображён в разделе "Responses". Запрос можно повторить снова нажав кнопку "Execute" и введя другой параметр. Или очистить содержимое запроса нажав на кнопку "Clear".
			[[File:Изменения.png\|thumb\|center\| Пример отображения ответа и изменения интерфейса после запроса к серверу\|800px]]
	== '''Схемы (Schemas)''' ==		== '''Схемы (Schemas)''' ==
	Данный раздел описывает информацию о структуре данных, с которыми работает API.		Данный раздел описывает информацию о структуре данных, с которыми работает API.
Строка 135:		Строка 137:
	[[File:Вложенность_вкладок.png\|thumb\|center\| Пример отображения вложенных вкладок\|800px]]		[[File:Вложенность_вкладок.png\|thumb\|center\| Пример отображения вложенных вкладок\|800px]]
	== '''Взаимодействие через Postman''' ==		== '''Взаимодействие через Postman''' ==
	Для продвинутых пользователей доступен альтернативный вариант - обращение к ресурсам компании SmartPlayer через Postman.<br>		Для продвинутых пользователей доступен альтернативный вариант — обращение к ресурсам компании SmartPlayer через Postman.<br>
	Установив и запустив Postman пользователю необходимо выбрать сервер, к которому он будет обращаться и прописать (скопировать) его URL-адрес.		Установив и запустив Postman пользователю необходимо выбрать сервер, к которому он будет обращаться и прописать (скопировать) его URL-адрес.
	== '''Видеоинструкция''' ==		== '''Видеоинструкция''' ==

N.Bloshkin в 12:55, 23 апреля 2026

2026-04-23T12:55:01Z

← Предыдущая версия		Версия от 15:55, 23 апреля 2026
Строка 103:		Строка 103:
	=== '''Информация внутри метода''' ===		=== '''Информация внутри метода''' ===
	Каждый метод можно развернуть по иконке ">" и просмотреть его содержимое. Внутри метода отображается следующая информация:		Каждый метод можно развернуть по иконке ">" и просмотреть его содержимое. Внутри метода отображается следующая информация:
			* краткое описание метода (на английском);
			* параметры (Parameters) запроса;
			* тело запроса (Request body), с возможность просмотра примера значений (Example Values) или схемы (Schema);
			* ответы (Responses) с кодами ответов.
			=== '''Кнопка "Try"it out''' ===
			Кнопка "Try it out" позволяет пользователю попробовать сделать запрос к любому выбранному ранее серверу.

			При ее нажатии интерфейс немного меняется предлагая пользователю либо тело запроса, либо строку для ввода значения параметра.

			Отправить запрос можно кликнув по кнопке "Execute". Ответ приходит сразу же по нажатию.

			Запрос можно повторить снова нажав кнопку "Execute" и введя другой параметр. Или очистить содержимое запроса нажав на кнопку "Clear".
	== '''Схемы (Schemas)''' ==		== '''Схемы (Schemas)''' ==
	Данный раздел описывает информацию о структуре данных, с которыми работает API.		Данный раздел описывает информацию о структуре данных, с которыми работает API.

N.Bloshkin в 12:48, 23 апреля 2026

2026-04-23T12:48:26Z

← Предыдущая версия		Версия от 15:48, 23 апреля 2026
Строка 102:		Строка 102:
	[[File:Методы_устройства.png\|thumb\|center\| Пример отображения доступного метода для устройств\|800px]]		[[File:Методы_устройства.png\|thumb\|center\| Пример отображения доступного метода для устройств\|800px]]
	=== '''Информация внутри метода''' ===		=== '''Информация внутри метода''' ===
			Каждый метод можно развернуть по иконке ">" и просмотреть его содержимое. Внутри метода отображается следующая информация:


	== '''Схемы (Schemas)''' ==		== '''Схемы (Schemas)''' ==
	Данный раздел описывает информацию о структуре данных, с которыми работает API.		Данный раздел описывает информацию о структуре данных, с которыми работает API.

N.Bloshkin в 12:43, 23 апреля 2026

2026-04-23T12:43:33Z

@@ Строка 103: / Строка 103: @@
 === '''Информация внутри метода''' ===
 == '''Схемы (Schemas)''' ==
 == '''Взаимодействие через Postman''' ==
 == '''Видеоинструкция''' ==
 [https://vkvideo.ru/video-227547238_456239130 Подключение к внешнему REST API]