Sv translation | |||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||
Подробнее про работу с API рассказано на этой странице, а также в видео:
Чтобы перейти к документации, выберите раздел API в административной панели или перейдите по ссылке. Agora REST APIВы можете использовать эту спецификацию для работы с API-методами с помощью Postman: загрузить. Что такое API?API (от англ. application programming interface — интерфейс программирования приложений) — это интерфейс, который дает возможность с помощью специальных команд управлять каким-либо программным обеспечением (например, приложением, сервисом, программой). Для чего используют API Agora?Мы предлагаем описание тех методов API, которыми вы сможете оперировать для выполнения таких задач, как:
Особенности API AgoraПротокол передачи данныхAPI поддерживает HTTPS протоколы. Формат запросовAPI поддерживает CORS — кросс-доменные запросы. В API Agora используются запросы. АвторизацияЗапросы требуют API-ключ для авторизации. Чтобы получить ключ, нужно отправить запрос следующий URL для авторизации: . Запрос ожидается в формате и содержит следующие поля:
Формат запросаВ запросах используется формат . Формат ответаФорматом ответа по умолчанию является JSON. Структура ответаОтвет при запросе списка объектов содержит параметры:
Пример ответа см. в разделе "фильтрация запросов". При запросе объекта по определенному pk ответ содержит один JSON объект с названиями и значениями свойств запрошенного объекта. Пример ответа при запросе на url /news/1/: Фильтрация запросовВ API Agora есть возможность фильтрации по URL. Чтобы отфильтровать получаемые данные, нужно в query-параметры url передать поле для фильтрации и нужное значение. Пример запроса с фильтрацией новостей. URL: https://api-cloud.agora.ru/api/rest/v1/news/?title=Тест Ответ: ОшибкиВсе ошибки представляются в виде человеко- и машиночитаемого статуса. Тело ответа содержит более детальную информацию об ошибке и формируется в зависимости от её типа. Большая часть ошибок содержит в теле ключ "detail". Пример: Ошибки валидации, однако, содержат ключи, которые соответствуют полям запроса, либо "non_field_errors"в том случае, если ошибка не завязана на значении какого-то конкретного поля запроса. Пример: Описание используемых статус кодов:
Отправка тестового запросаДля проверки работы API можно отправить тестовый запрос из соответствующего подраздела документации:
|
...