Translations:Подключение к внешнему REST API/3/ru

Схемы (Schemas)

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

Пример отображения раздела "Schemas"

Понимание схемы данных даёт пользователю API:

1. Понимание форматов ответа.
2. Понимание форматов запроса.
3. Типы данных.
4. Обязательность полей.
5. Понимание наличия/отсутствия вложенных структур.
6. Возможность повторного использования моделей.
7. Понимание ошибок.

Чтобы развернуть любую вкладку раздела, пользователю нужно нажать на иконку ">". После открытия вкладки пользователь увидит два столбца:

• первый столбец — название параметра;
• второй столбец — тип данных параметра.

Пример отображения отображаемой информации на открытой вкладке

В некоторых случаях под типом данных (во втором столбце) располагается описание или пример (example).

Пример отображения описания или примеров

Также присутствует ситуация, когда пользователь вместо типа данных получает ещё одну вкладку (название + ">"). Необходимо просто разворачивать доступные вкладки по иконке ">". Вложенностей такого формата может быть несколько.

Пример отображения вложенных вкладок

Взаимодействие через Postman

Для продвинутых пользователей доступен альтернативный вариант — обращение к ресурсам компании SmartPlayer через Postman.
Установив и запустив Postman, пользователю необходимо нажать на кнопку "New" и выбрать вариант типа API. В данном случае это "HTTP" (он же REST).

Пример отображения интерфейса Postman

После необходимо выбрать тип запроса из списка и вставить нужный URL-адрес (название сервера + /название конечной точки). В данном примере URL-адрес будет: https://develop-api.smartplayer.org/login.

Пример отображения тип запроса и URL-адреса

Настроить параметры в разделе "Headers", по необходимости (параметры указаны на портале в теле метода) и тело запроса "Body" → "Raw" (если необходимо, также в теле описания метода на портале).

Пример отображения "Headers" и "Body" → "Row"

Также в зависимости от запроса может понадобиться настроить авторизацию (раздел "Authorization" в Postman). Она реализована через "bearer token".

Далее нажимаем на кнопку "Send" и моментально получаем ответ, который расположен в нижней части экрана.

Пример отображения кнопки "Send" и ответа по запросу

Сравниваем его с информацией, указанной на портале.

Видеоинструкция

Подключение к внешнему REST API

Дополнительная информация

Если данная статья не помогает использовать функционал по назначению или после её прочтения остаются вопросы, их можно задать в разделе "Обсуждения" вверху страницы.

Пример отображения вкладки "Обсуждения" на wiki-странице

Найти дополнительную информацию можно на странице Как взаимодействовать пользователю с разделом "Обсуждения"