Подключить домен

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

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

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

Чтобы использовать возможности Яндекс Почты для домена, нужно подключить домен и подтвердить его. Пользователь, подтвердивший домен, становится администратором этого домена. Администратор имеет полный доступ к управлению доменом, а также может назначать своих заместителей.

Запрос позволяет подключить домен.

Способы подтверждения домена описаны на справочной странице Яндекс Почты для домена. Если вы делегировали домен на Яндекс, подтверждать его не потребуется.

  1. Синтаксис запроса
  2. Пример запроса
  3. Структура ответа

Синтаксис запроса

Запрос следует отправлять по протоколу HTTPS с помощью метода POST.

POST /api2/admin/domain/register
Host: pddimp.yandex.ru
PddToken: <ПДД-токен>
...

domain=<имя домена>

Заголовки:

Название Описание
PddToken

ПДД-токен.
Название Описание
PddToken

ПДД-токен.

Параметры:

Параметр Тип Значение
Обязательные
domain Строка

Имя домена.
Параметр Тип Значение
Обязательные
domain Строка

Имя домена.

Пример запроса

POST /api2/admin/domain/register HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
...
domain=domain.com
cURL
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' -d 'domain=domain.com' 'https://pddimp.yandex.ru/api2/admin/domain/register'

Структура ответа

{
  "domain": "{имя домена}",   
  "status": "{статус домена}", 
  "stage": "{служебный ключ}",
  "secrets": 
  {    
    "name": "{секретная часть имени проверочного файла}", 
    "content": "{секретное содержимое проверочного файла}"
  },
  "success": "{статус выполнения запроса}"
}
Ключ Тип значения Описание
domain Строка

Имя домена.
status Строка

Статус домена.

Возможные значения:
  • domain-activate — домен добавлен в Почту для домена, но не подтвержден.
  • mx-activate — домен подтвержден, но MX-запись не настроена (почта не работает).
  • added — домен подтвержден, MX-запись настроена.
stage Строка

Ключ дублирует status в служебных целях.

Возможные значения:
  • owner-check — домен добавлен в Почту для домена, но не подтвержден.
  • mx-check — домен подтвержден, но MX-запись не настроена.
  • added — домен подтвержден, MX-запись настроена.
secrets Объект

Секретные данные проверочного файла (или CNAME-записи).

Ключ включается в ответ, если значение status равно domain-activate.
success Строка

Статус выполнения запроса.

Возможные значения:
  • ok — запрос выполнен успешно.
  • error — запрос выполнен с ошибкой.
error Строка

Код ошибки.

Ключ включается в ответ, если запрос выполнен с ошибкой.

Возможные значения:
  • unknown — произошел временный сбой или ошибка работы API (повторите запрос позже).
  • no_token (no_domain, no_ip ) — не передан обязательный параметр.
  • bad_domain — имя домена не указано или не соответствует RFC.
  • prohibited — запрещенное имя домена.
  • bad_token (bad_login, bad_passwd) — передан неверный ПДД-токен (логин, пароль).
  • no_auth — не передан заголовок PddToken.
  • not_allowed — пользователю недоступна данная операция (он не является администратором этого домена).
  • blocked — домен заблокирован (например, за спам и т.п.).
  • occupied — имя домена используется другим пользователем.
  • domain_limit_reached — превышено допустимое количество подключенных доменов (50).
  • no_reply — Яндекс Почта для домена не может установить соединение с сервером-источником для импорта.
Ключи объекта secrets
name Строка Секретная часть имени проверочного файла (или CNAME-записи).
content Строка Секретное содержимое проверочного файла.
Ключ Тип значения Описание
domain Строка

Имя домена.
status Строка

Статус домена.

Возможные значения:
  • domain-activate — домен добавлен в Почту для домена, но не подтвержден.
  • mx-activate — домен подтвержден, но MX-запись не настроена (почта не работает).
  • added — домен подтвержден, MX-запись настроена.
stage Строка

Ключ дублирует status в служебных целях.

Возможные значения:
  • owner-check — домен добавлен в Почту для домена, но не подтвержден.
  • mx-check — домен подтвержден, но MX-запись не настроена.
  • added — домен подтвержден, MX-запись настроена.
secrets Объект

Секретные данные проверочного файла (или CNAME-записи).

Ключ включается в ответ, если значение status равно domain-activate.
success Строка

Статус выполнения запроса.

Возможные значения:
  • ok — запрос выполнен успешно.
  • error — запрос выполнен с ошибкой.
error Строка

Код ошибки.

Ключ включается в ответ, если запрос выполнен с ошибкой.

Возможные значения:
  • unknown — произошел временный сбой или ошибка работы API (повторите запрос позже).
  • no_token (no_domain, no_ip ) — не передан обязательный параметр.
  • bad_domain — имя домена не указано или не соответствует RFC.
  • prohibited — запрещенное имя домена.
  • bad_token (bad_login, bad_passwd) — передан неверный ПДД-токен (логин, пароль).
  • no_auth — не передан заголовок PddToken.
  • not_allowed — пользователю недоступна данная операция (он не является администратором этого домена).
  • blocked — домен заблокирован (например, за спам и т.п.).
  • occupied — имя домена используется другим пользователем.
  • domain_limit_reached — превышено допустимое количество подключенных доменов (50).
  • no_reply — Яндекс Почта для домена не может установить соединение с сервером-источником для импорта.
Ключи объекта secrets
name Строка Секретная часть имени проверочного файла (или CNAME-записи).
content Строка Секретное содержимое проверочного файла.