Документация
API Яндекс.Почты для домена

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

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

Запрос позволяет:

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

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

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

GET /api2/admin/dkim/status?
domain
[no-highlight[

Тип

Строка

Значение

Имя домена.

]no-highlight]
=<имя домена> &secretkey
[no-highlight[

Тип

Строка

Значение

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

]no-highlight]
=<получение секретного ключа> Host: pddimp.yandex.ru PddToken
[no-highlight[

Описание

ПДД-токен.

]no-highlight]
: <ПДД-токен>

Заголовки:

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

ПДД-токен.

Параметры:

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

Имя домена.

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

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

GET /api2/registrar/dkim/status?
domain
[no-highlight[

Тип

Строка

Значение

Имя домена.

]no-highlight]
=<имя домена> &secretkey
[no-highlight[

Тип

Строка

Значение

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

]no-highlight]
=<получение секретного ключа> Host: pddimp.yandex.ru PddToken
[no-highlight[

Описание

ПДД-токен.

]no-highlight]
: <ПДД-токен> Authorization
[no-highlight[

Описание

OAuth-токен.

]no-highlight]
: OAuth <OAuth-токен>

Заголовки:

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

ПДД-токен.

Authorization

OAuth-токен.

Параметры:

ПараметрТипЗначение
Обязательные
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'
GET /api2/admin/dkim/status?domain=domain.com&secretkey=yes HTTP/1.1
Host: pddimp.yandex.ru
PddToken: 123456789ABCDEF0000000000000000000000000000000000000
Authorization: OAuth 00123456789ABCDEF00000000000000000000000000000000000
cURL
curl -H 'PddToken: 123456789ABCDEF0000000000000000000000000000000000000' -H 'Authorization: OAuth 00123456789ABCDEF00000000000000000000000000000000000' 'https://pddimp.yandex.ru/api2/admin/dkim/status?domain=domain.com&secretkey=yes'

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

{
  "domain
[no-highlight[

Тип значения

Строка

Описание

Имя домена.

]no-highlight]
": "{имя домена}", "dkim
[no-highlight[

Тип значения

Объект

Описание

Информация о подключении DKIM, публичном и секретном ключе DKIM.

]no-highlight]
": { "enabled
[no-highlight[

Тип значения

Строка

Описание

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

Возможные значения:

  • yes — DKIM-подпись подключена.
  • no — DKIM-подпись отключена c помощью запроса Отключить DKIM.

]no-highlight]
": "{статус подключения DKIM}", "txtrecord
[no-highlight[

Тип значения

Строка

Описание

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
]no-highlight]
": "{TXT-запись}", "nsready
[no-highlight[

Тип значения

Строка

Описание

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

Возможные значения:

  • yes — TXT-запись установлена.
  • no — TXT-запись отсутствует.

]no-highlight]
": "{наличие TXT-записи}", "mailready
[no-highlight[

Тип значения

Строка

Описание

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

Возможные значения:

  • yes — Яндекс.Почта для домена готова.
  • no — Яндекс.Почта для домена не готова.

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

]no-highlight]
": "{готовность Яндекс.Почты для домена подписывать письма}", "secretkey
[no-highlight[

Тип значения

Строка

Описание

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

]no-highlight]
": "{секретный ключ DKIM}" }, "success
[no-highlight[

Тип значения

Строка

Описание

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

Возможные значения:

  • ok — запрос выполнен успешно.
  • error — запрос выполнен с ошибкой.

]no-highlight]
": "{статус выполнения запроса}" }
{
  "domain
[no-highlight[

Тип значения

Строка

Описание

Имя домена.

]no-highlight]
": "{имя домена}", "success
[no-highlight[

Тип значения

Строка

Описание

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

Возможные значения:

  • ok — запрос выполнен успешно.
  • error — запрос выполнен с ошибкой.

]no-highlight]
": "{статус выполнения запроса}", "error
[no-highlight[

Тип значения

Строка

Описание

Код ошибки.

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

Возможные значения:

  • 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 — Яндекс.Почта для домена не может установить соединение с сервером-источником для импорта.

]no-highlight]
": "{код ошибки}" }
НазваниеТип значенияОписание
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.