Настройка API

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

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

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

Авторизация запросов с помощью OAuth 2.0

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

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

  1. При создании приложения вы регистрируете его с помощью Google API Console . Затем Google предоставляет информацию, которая понадобится вам позже, например идентификатор клиента и секретный код клиента.
  2. Активируйте API Postmaster Tools в консоли API Google. (Если 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 Разрешает доступ только для чтения к данным Postmaster Tools.

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