Тестирование с различными типами учетных данных и областями действия

Раздел «Учётные данные» в обозревателе API позволяет проводить тестирование с различными учётными данными и областями действия. Эта функция полезна для обеспечения использования минимально необходимых учётных данных и области действия для вызова конечной точки API.

Тест с разными учетными данными

По умолчанию выбраны оба типа учётных данных: OAuth 2 и API Key. Если вы хотите провести тестирование только с одним типом учётных данных, выберите нужный тип учётных данных (и снимите флажок с другого типа). Ниже приведены общие правила выбора учётных данных для тестирования:

  • Если вы используете метод доступа к публичным данным, например, к данным Google Карт, вы можете использовать ключ API в качестве учётных данных. Установите флажок «Ключ API» и снимите флажок «Google OAuth 2.0» .

  • Если вы используете метод доступа к личным данным, например к данным пользователя на Google Диске, необходимо использовать учетные данные OAuth 2. Снимите флажок API key и установите флажок Google OAuth 2.0 .

Если вы получили результат 200, учётных данных достаточно для доступа к данным. Если вы получили результат 401, для доступа к данным необходимо использовать учётные данные OAuth 2.

Тестирование с различными областями

Область действия — это строка, например https://www.googleapis.com/auth/drive.metadata.readonly , определяющая уровень доступа к ресурсам, необходимым вашему приложению, например, к данным, принадлежащим пользователям. В идеале ваше приложение должно использовать области действия с максимально узким уровнем доступа к данным пользователя. Разные методы могут требовать разных областей действия. Например, метод в API может требовать как минимум область действия только для чтения, в то время как другие методы могут требовать область действия только для чтения и записи.

По умолчанию все области действия Google OAuth 2.0 для API включены в обозревателе API. Чтобы протестировать определённую область действия:

  1. В разделе «Учетные данные Google OAuth 2.0» нажмите «Показать области действия» .
  2. Проверьте область действия, используемую при вызове метода.
  3. Нажмите «Выполнить» , чтобы выполнить API, используя только выбранную область. В обозревателе API появится экран авторизации с запросом на предоставление доступа к области.
  4. Нажмите «Разрешить» . Результаты появятся под кнопкой «Выполнить».

Если в обозревателе API отображается результат 200 в разделе "application/json", то область действия достаточна для вызова метода. Если в обозревателе API отображается результат 403, то выбранная область действия недостаточна для вызова метода. Попробуйте расширить область действия.

Дополнительную информацию о выборе области действия см. в разделе «Аутентификация и авторизация» документации для вашего конкретного API Google.

Отменить авторизованный доступ для тестирования с новыми областями

После того, как вы подтвердили авторизацию на экране авторизации Google, API Explorer сохраняет право выполнять аутентифицированные запросы до тех пор, пока не истечёт срок действия учётных данных. Снятие отметок с областей не сбрасывает ранее утверждённые учётные данные и сами области. Чтобы провести тестирование с новой конфигурацией области, необходимо отозвать ранее утверждённые учётные данные.

Чтобы отозвать учетные данные, используемые API Explorer:

  1. Перейдите в раздел «Приложения», у которых есть доступ к вашей учетной записи .
  2. В разделе Сторонние приложения с доступом к учетной записи нажмите Google APIs Explorer .
  3. Нажмите Удалить доступ .
  4. (необязательно) Перезагрузите страницу документации, чтобы сбросить настройки обозревателя API.