Доступ к API

Внимание. Сервис Яндекс Почта для домена больше не поддерживается. API Почты для домена прекратит работу с 1 апреля 2023 года. С 24 марта доступность сервиса будет ограничена.

Для управления доменами, пользователями и организациями используйте сервис Яндекс 360 для бизнеса.

Документация API 360

API могут пользоваться:
  • Администраторы — это пользователи ПДД, которые подключили и подтвердили хотя бы один домен с помощью интерфейса Яндекс Почты для домена. Администраторы могут управлять своими доменами и почтой на них (например, подключать почту на домене для организации или пользователей определенного сайта).

  • Регистраторы — это пользователи ПДД, которые управляют (регистрируют, паркуют и т. п.) доменами администраторов и их почтой.

Доступ для администратора

Администратору доступны все функции API. Чтобы использовать их, нужно передавать в каждом запросе ПДД-токен в заголовке PddToken. Получить ПДД-токен можно на странице управления токеном, указав имя ранее подтвержденного домена.

Доступ для регистратора

Регистратору доступны все функции API, кроме управления заместителями администратора.

Чтобы использовать запросы, регистратору нужно передавать в каждом из них:
  1. ПДД-токен в заголовке PddToken.
  2. OAuth-токен в заголовке Authorization.

Получение ПДД-токена

Чтобы получить ПДД-токен, нужно:
  1. Зарегистрировать приложение на сервисе Яндекс OAuth. Атрибуты нужно указать следующим образом:
    • Название — название приложения, определяющее регистратора.
    • Права — Яндекс.Почта для домена → Список доменов и ящиков в Почте для домена, право подключать домены, создавать и удалять ящики.
    • Callback URL — URL перенаправления, на который будут передаваться данные об OAuth-токене.
  2. Создать учетную запись регистратора на странице управления регистратором.
  3. Указать идентификатор OAuth-приложения на странице управления регистратором, в поле OAuth client ID.
  4. Получить ПДД-токен на странице управления токеном, указав идентификатор ранее созданного регистратора.

Получение OAuth-токена

Чтобы действовать от имени администратора, регистратору нужно получить OAuth-токен для приложения, которое было создано при получении ПДД-токена.

Для этого регистратору нужно направить администратора на URL запроса OAuth-токена, где администратор должен разрешить доступ к своим данным. Яндекс OAuth передаст данные о токене на URL перенаправления. Подробнее читайте в инструкции о веб-приложении.

Другие способы получения OAuth-токенов рассмотрены в документе о Яндекс OAuth.