Настройка API

Каждый запрос, отправляемый вашим приложением к API Postmaster Tools, должен включать токен авторизации. Этот токен также идентифицирует ваше приложение для Google.

О протоколах авторизации

Для авторизации запросов ваше приложение должно использовать OAuth 2.0 . Другие протоколы авторизации не поддерживаются. Если ваше приложение использует вход через Google , некоторые аспекты авторизации обрабатываются автоматически.

Авторизация запросов с использованием OAuth 2.0

Все запросы к API Postmaster Tools должны быть авторизованы аутентифицированным пользователем.

Детали процесса авторизации, или «потока», для OAuth 2.0 несколько различаются в зависимости от типа разрабатываемого приложения. Следующий общий процесс применим ко всем типам приложений:

  1. При создании приложения вы регистрируете его через консоль Google API . Затем Google предоставляет информацию, которая понадобится вам позже, например, идентификатор клиента и секретный ключ клиента.
  2. Активируйте API Postmaster Tools в консоли Google API. (Если API не отображается в консоли API, пропустите этот шаг.)
  3. Когда вашему приложению требуется доступ к пользовательским данным, оно запрашивает у Google определенный объем доступа.
  4. Google отображает пользователю экран согласия , в котором ему предлагается разрешить вашему приложению запрашивать некоторые из его данных.
  5. Если пользователь одобрит запрос, Google предоставит вашему приложению кратковременный токен доступа .
  6. Ваше приложение запрашивает данные пользователя, прикрепляя к запросу токен доступа.
  7. Если Google определит, что ваш запрос и токен действительны, он вернет запрошенные данные.

Некоторые сценарии включают дополнительные шаги, например, использование токенов обновления для получения новых токенов доступа. Подробную информацию о сценариях для различных типов приложений см. в документации Google по OAuth 2.0 .

Вот информация об области действия OAuth 2.0 для API Postmaster Tools:

Объем Значение
https://www.googleapis.com/auth/postmaster.readonly Предоставляет доступ только для чтения к данным инструментов администратора почты.

Для запроса доступа с использованием OAuth 2.0 вашему приложению необходима информация об области действия, а также информация, которую Google предоставляет при регистрации вашего приложения (например, идентификатор клиента и секретный ключ клиента).