Все переводы
Материал из SmartPlayer
Введите имя сообщения для показа всех доступных переводов.
Найдено 2 перевода.
| Сообщение | Текущий текст |
|---|---|
| ист. английский (en) | == '''Schemas''' == <div class="mw-collapsible mw-collapsed" style="border:1px solid #aaa; padding:8px; background:#f9f9f9;"> This section describes API data structures. [[File:Раздел_схемы.png|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:Раздел_схемы.png|thumb|center| Example of schema details|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> == '''Postman Interaction''' == <div class="mw-collapsible mw-collapsed" style="border:1px solid #aaa; padding:8px; background:#f9f9f9;"> Advanced users can use Postman. Create request: [[File:Новый_запрос_в_постман.png|thumb|center| Example of Postman|800px]] Set method and URL: [[File:Вариант_запроса.png|thumb|center| Example of request setup|800px]] Configure headers and body: [[File:Тело_запроса.png|thumb|center| Example of headers and body|800px]] {{Note|Authorization may be required via bearer token.|warn}} Send request: [[File:Тело_ответа.png|thumb|center| Example of response|800px]] </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]] |
| ист. русский (ru) | == '''Схемы (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]] Найти дополнительную информацию можно на странице [[Как взаимодействовать пользователю с разделом "Обсуждения"]] |
