На большинстве страниц документации сжатый обозреватель API отображается в правой части экрана. Если обозреватель API не отображается, щелкните Попробовать! для отображения сокращенной версии проводника API.
Если Попробуйте! не отображается в правой части страницы справочной документации, этот метод не поддерживается обозревателем API. Например, обозреватель API несовместим с API, для которых требуются сервисные учетные записи, поэтому он не отображается на страницах документации по этим API.
Показать расширенную версию проводника API
Расширенная версия обозревателя API содержит образцы кода cURL, HTTP и, возможно, другие. Чтобы отобразить расширенную версию обозревателя API, щелкните Полноэкранный режим .
Выполнить метод
Проводник API позволяет вводить обязательные параметры, необязательные параметры и, если применимо, тело запроса для методов API. Для многих методов REST, таких как методы списка, вам нужно заполнить только одно или два поля, прежде чем вы сможете выполнить метод. Например, для метода books.volumes.list в Books API требуется только параметр запроса ( q ) для вывода списка книг. Чтобы попробовать метод books.volumes.list :
- Перейдите к
books.volumes.list. - Если обозреватель API не отображается, щелкните Попробовать!
- В поле
qвведите « Голодные игры » (без кавычек и специальных символов). - Прокрутите вниз и нажмите «Выполнить ».
- (необязательно) На экране входа в Google вам будет предложено выбрать учетную запись Google.
- (необязательно) В диалоговом окне авторизации Google вас спросят, можете ли вы «Управлять своими книгами». Щелкните Разрешить . Результаты отображаются под кнопкой «Выполнить».
Если проводник API показывает результат 200, то метод был успешным.
Устранение проблем с проводником API
Вы получили ошибку 401 или 403
Если вы получаете сообщение об ошибке 401 или 403 при выполнении метода с помощью обозревателя API, вероятно, это связано с одной из следующих проблем:
- Вы используете неправильный тип авторизации (ключ API вместо OAuth 2.0). Попробуйте изменить тип авторизации.
- Вы используете OAuth 2.0, но в слишком узкой области. Попробуйте использовать более широкий охват.
Диалог авторизации не появляется
Проводник API использует всплывающее окно для предоставления доступа к вашим личным данным. Если ваш браузер блокирует всплывающие окна, это всплывающее окно не появится, и вы не сможете предоставить доступ.
Если вы нажмете Разрешить в диалоговом окне авторизации и ничего не произойдет, попробуйте изменить настройки всплывающих окон браузера, чтобы включить всплывающие окна.