Подключить DKIM

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

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

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

Запрос позволяет подключить DKIM для домена, делегированного на Яндекс. При этом DNS-записи будут настроены автоматически.

Если домен делегирован на сторонние серверы, с помощью данного запроса получите публичный ключ и настройте DNS-записи самостоятельно.

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

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

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

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

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

Заголовки:

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

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

ПДД-токен.

Параметры:

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

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

Имя домена.

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

POST /api2/admin/dkim/enable 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/dkim/enable'

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

{
  "domain": "{имя домена}",
  "dkim": 
  {    
    "enabled": "{статус подключения DKIM}", 
    "txtrecord": "{TXT-запись}"
  },
  "success": "{статус выполнения запроса}"
}
Название Тип значения Описание
domain Строка

Имя домена.
dkim Объект

Информация о подключении DKIM, публичном и секретном ключе DKIM.
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 — Яндекс Почта для домена не может установить соединение с сервером-источником для импорта.
Ключи объекта dkim
enabled Строка

Статус подключения DKIM для домена.

Возможные значения:
  • yes — DKIM-подпись подключена.
  • no — DKIM-подпись отключена c помощью запроса Отключить DKIM.
txtrecord Строка

TXT-запись с публичным ключом DKIM для самостоятельной настройки. Запись состоит из трех частей:

  • Имя записи (mail._domainkey).

  • Параметры DKIM:

    v=DKIM1;
k=rsa;
t=s;
p=MIGfMA0GCSEBtaCOteH4EBqJlKperJ+5BPEGS7N3fFkdeKllShrM73nm4xPdZmt2jNnmgWMeQySGYW5VUJ8PCePanwIXcW8YnqS7zw+grL/PHhUtf3ofSLmtVM3rSWmJ9qHFhxWmPFplPe5OsvpO+fphiMOrTnzzV/004S/jQIDAQAB

    Параметр p содержит открытый ключ DKIM.

  • Указание на домен (DKIM key mail for example.com).

Пример TXT-записи: 

mail._domainkey IN TXT "v=DKIM1; k=rsa; t=s; p=MIGfMA0GCSEBtaCOteH4EBqJlKperJ+5BPEGS7N3fFkdeKllShrM73nm4xPdZmt2jNnmgWMeQySGYW5VUJ8PCePanwIXcW8YnqS7zw+grL/PHhUtf3ofSLmtVM3rSWmJ9qHFhxWmPFplPe5OsvpO+fphiMOrTnzzV/004S/jQIDAQAB" ; DKIM key mail for example.com
Название Тип значения Описание
domain Строка

Имя домена.
dkim Объект

Информация о подключении DKIM, публичном и секретном ключе DKIM.
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 — Яндекс Почта для домена не может установить соединение с сервером-источником для импорта.
Ключи объекта dkim
enabled Строка

Статус подключения DKIM для домена.

Возможные значения:
  • yes — DKIM-подпись подключена.
  • no — DKIM-подпись отключена c помощью запроса Отключить DKIM.
txtrecord Строка

TXT-запись с публичным ключом DKIM для самостоятельной настройки. Запись состоит из трех частей:

  • Имя записи (mail._domainkey).

  • Параметры DKIM:

    v=DKIM1;
k=rsa;
t=s;
p=MIGfMA0GCSEBtaCOteH4EBqJlKperJ+5BPEGS7N3fFkdeKllShrM73nm4xPdZmt2jNnmgWMeQySGYW5VUJ8PCePanwIXcW8YnqS7zw+grL/PHhUtf3ofSLmtVM3rSWmJ9qHFhxWmPFplPe5OsvpO+fphiMOrTnzzV/004S/jQIDAQAB

    Параметр p содержит открытый ключ DKIM.

  • Указание на домен (DKIM key mail for example.com).

Пример TXT-записи: 

mail._domainkey IN TXT "v=DKIM1; k=rsa; t=s; p=MIGfMA0GCSEBtaCOteH4EBqJlKperJ+5BPEGS7N3fFkdeKllShrM73nm4xPdZmt2jNnmgWMeQySGYW5VUJ8PCePanwIXcW8YnqS7zw+grL/PHhUtf3ofSLmtVM3rSWmJ9qHFhxWmPFplPe5OsvpO+fphiMOrTnzzV/004S/jQIDAQAB" ; DKIM key mail for example.com