Получить информацию о DKIM

DKIM (DomainKeys Identified Mail) — механизм подписи электронных писем, позволяющий идентифицировать домен отправителя.

Запрос позволяет:
  • узнать почему исходящие письма не подписываются (например, в настройках DNS нет записи с публичным ключом DKIM);
  • получить публичный ключ DKIM, чтобы вручную добавить его в настройки DNS;
  • получить секретный ключ DKIM, чтобы настроить подпись писем на собственном почтовом сервере.
  1. Синтаксис запроса
  2. Пример запроса
  3. Структура ответа

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

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

GET /api2/admin/dkim/status?
domain=<имя домена>
&secretkey=<получение секретного ключа>

Host: pddimp.yandex.ru
PddToken: <ПДД-токен>

Заголовки:

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

ПДД-токен.

Параметры:

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

Имя домена.

Необязательные
secretkeyСтрока

Параметр позволяет запросить секретный ключ DKIM. Допустимо только одно значение: yes.

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

GET /api2/admin/dkim/status?domain=domain.com&secretkey=yes HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
cURL
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' 'https://pddimp.yandex.ru/api2/admin/dkim/status?domain=domain.com&secretkey=yes'

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

{
  "domain": "{имя домена}",
  "dkim": 
  {    
    "enabled": "{статус подключения DKIM}", 
    "txtrecord": "{TXT-запись}",
    "nsready": "{наличие TXT-записи}",
    "mailready": "{готовность Яндекс.Почты для домена подписывать письма}",
    "secretkey": "{секретный ключ DKIM}"
  },
  "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
nsreadyСтрока

Наличие TXT-записи.

Возможные значения:
  • yes — TXT-запись установлена.
  • no — TXT-запись отсутствует.
mailreadyСтрока

Готовность Яндекс.Почты для домена подписывать письма согласно DKIM.

Возможные значения:
  • yes — Яндекс.Почта для домена готова.
  • no — Яндекс.Почта для домена не готова.

Яндекс.Почта для домена проверяет данные о DKIM с задержкой. Поэтому, если пользователь добавил TXT-запись, значение mailready может быть равно no. Нужно проверить готовность позже.

secretkeyСтрока

Секретный ключ DKIM.