Обзор

Интеграции

Руководство пользователя

Справочник API

Вебхуки

API подписей отправителей

Позволяет управлять всеми подписями отправителей вашего аккаунта.

Список подписей отправителей #

get

/senders

Получает список подписей отправителей с краткой информацией, связанной с вашим аккаунтом.

Заголовки запроса

Accept обязательный

application/json

X-Haskimail-Account-Token обязательный

Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail.

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

curl "https://api.haskimail.ru/senders?count=50&offset=0" \
  -X GET \
  -H "Accept: application/json" \
  -H "X-Haskimail-Account-Token: account token"

Параметры запроса

count обязательный

Количество записей для возврата в одном запросе. Максимум 500.

offset обязательный

Количество записей, которое необходимо пропустить.

Ответ

TotalCount integer

Указывает, сколько подписей отправителей соответствует указанным критериям поиска. Это число может быть больше, чем возвращено в одном запросе.

SenderSignatures array

Список объектов, каждый из которых представляет собой подпись отправителя.

Domain string

Домен, связанный с подписью отправителя.

EmailAddress string

Email-адрес подписи отправителя.

ReplyToEmailAddress string

Email-адрес для ответа, связанный с подписью отправителя.

Name string

Имя отправителя в подписи.

Confirmed boolean

Указывает, подтверждена ли эта подпись отправителя.

ID integer

Уникальный ID подписи отправителя.

Пример ответа

HTTP/1.1 200 OK
Content-Type: application/json

{
  "TotalCount": 2,
  "SenderSignatures": [
    {
      "Domain": "haskimail.ru",
      "EmailAddress": "jp@haskimail.ru",
      "ReplyToEmailAddress": "info@haskimail.ru",
      "Name": "JP Toto",
      "Confirmed": true,
      "ID": 36735
    },
    {
      "Domain": "example.com",
      "EmailAddress": "jp@example.com",
      "ReplyToEmailAddress": "",
      "Name": "JP Toto",
      "Confirmed": true,
      "ID": 81605
    }
  ]
}

Получение деталей подписи отправителя #

get

/senders/{signatureid}

Получает все детали для конкретной подписи отправителя.

Заголовки запроса

Accept обязательный

application/json

X-Haskimail-Account-Token обязательный

Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail.

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

curl "https://api.haskimail.ru/senders/{signatureid}" \
  -X GET \
  -H "Accept: application/json" \
  -H "X-Haskimail-Account-Token: account token"

Ответ

Domain string

Домен, связанный с подписью отправителя.

EmailAddress string

Email-адрес подписи отправителя.

ReplyToEmailAddress string

Email-адрес для ответа, связанный с подписью отправителя.

Name string

Имя отправителя в подписи.

Confirmed boolean

Указывает, подтверждена ли эта подпись отправителя.

SPFVerified boolean

Указывает, была ли когда-либо подтверждена SPF-подпись для домена.

SPFHost string

Имя хоста, используемое для конфигурации SPF.

SPFTextValue string

Значение, которое можно опционально настроить у вашего DNS-хостинга.

DKIMVerified boolean

Указывает, была ли когда-либо подтверждена DKIM-подпись для домена. Как только DKIM подтвержден, это поле останется true, даже если запись будет позже удалена из DNS.

DKIMHost string

DNS TXT-хост, используемый для валидации отправляемых сообщений.

DKIMTextValue string

Значение DNS TXT, используемое для валидации отправляемых сообщений.

DKIMPendingHost string

Если было инициировано обновление DKIM или это DKIM от новой подписи отправителя, это поле покажет ожидающий подтверждения DNS TXT-хост, который еще предстоит настроить и подтвердить у вашего регистратора или DNS-хостинга.

DKIMPendingTextValue string

Аналогично полю DKIMPendingHost, это поле покажет значение DNS TXT, ожидающее подтверждения у вашего регистратора или DNS-хостинга.

DKIMRevokedHost string

Как только новый DKIM будет подтвержден у вашего регистратора или DNS-хостинга, Haskimail отзовет старый DKIM-хост в рамках подготовки к его окончательному удалению из системы.

DKIMRevokedTextValue string

Аналогично DKIMRevokedHost, это поле покажет значение DNS TXT, которое скоро будет удалено из системы Haskimail..

SafeToRemoveRevokedKeyFromDNS boolean

Указывает, можете ли вы безопасно удалить старые DKIM DNS TXT-записи у вашего регистратора или DNS-хостинга. Новый DKIM теперь безопасно используется.

DKIMUpdateStatus string

Пока выполняются или настраиваются операции по обновлению или созданию нового DKIM, это поле будет иметь значение Pending. После того как все DNS TXT-записи будут обновлены и любые ожидающие операции обновления завершены, оно изменится на Verified.

ReturnPathDomain boolean

Пользовательский домен Return-Path для этой подписи. Для получения дополнительной информации об этом поле, пожалуйста, ознакомьтесь с нашей статьей..

ReturnPathDomainVerified boolean

Статус верификации домена Return-Path. Сообщает, используется ли Return-Path активно или все еще требует дополнительных действий для использования.

ReturnPathDomainCNAMEValue string

CNAME DNS-запись, которую Haskimail ожидает найти по адресу, указанному в ReturnPathDomain.

ID integer

Уникальный ID подписи отправителя.

ConfirmationPersonalNote string

Текст личного сообщения, отправленного получателю для подтверждения.

Пример ответа

HTTP/1.1 200 OK
Content-Type: application/json

{
  "Domain": "haskimail.ru",
  "EmailAddress": "jp@haskimail.ru",
  "ReplyToEmailAddress": "info@haskimail.ru",
  "Name": "JP Toto",
  "Confirmed": true,
  "SPFVerified": true,
  "SPFHost": "haskimail.ru",
  "SPFTextValue": "v=spf1 a mx include:spf.mtasv.net ~all",
  "DKIMVerified": false,
  "DKIMHost": "jan2013.pm._domainkey.haskimail.ru",
  "DKIMTextValue": "k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDJ...",
  "DKIMPendingHost": "20131031155228.pm._domainkey.haskimail.ru",
  "DKIMPendingTextValue": "k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCFn...",
  "DKIMRevokedHost": "",
  "DKIMRevokedTextValue": "",
  "SafeToRemoveRevokedKeyFromDNS": false,
  "DKIMUpdateStatus": "Pending",
  "ReturnPathDomain": "pm-bounces.haskimail.ru",
  "ReturnPathDomainVerified": false,
  "ReturnPathDomainCNAMEValue": "pm.mtasv.net",
  "ID": 36735,
  "ConfirmationPersonalNote": "Это личное сообщение, видимое получателю, чтобы объяснить, что такое Haskimail."
}

Создание подписи #

post

/senders

Заголовки запроса

Content-Type обязательный

application/json

Accept обязательный

application/json

X-Haskimail-Account-Token обязательный

Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail.

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

curl "https://api.haskimail.ru/senders" \
  -X POST \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Haskimail-Account-Token: account token" \
  -d '{
  "FromEmail": "ivan.ivanov@example.com",
  "Name": "Иван Иванов",
  "ReplyToEmail": "reply@example.com",
  "ConfirmationPersonalNote": "Это личное сообщение, видимое получателю, чтобы объяснить, что такое Haskimail."
}'

Body format

FromEmail string обязательный

Email-адрес, который будет связан с подписью отправителя.

Name string обязательный

Имя, которое будет связано с подписью отправителя.

ReplyToEmail string

Адрес для ответа, переопределяющий стандартный.

ReturnPathDomain string

Пользовательское значение для домена Return-Path. Это необязательное поле, но оно должно быть поддоменом вашего домена из поля FromEmail и иметь CNAME-запись, указывающую на hm.mtasv.net. Для получения дополнительной информации об этом поле, пожалуйста, ознакомьтесь с нашей статьей.

ConfirmationPersonalNote string

Необязательно. Способ предоставить получателю подтверждающего письма примечание, чтобы объяснить, что такое Haskimail. Максимальная длина 400 символов.

Пример формата тела запроса

{
  "FromEmail": "ivan.ivanov@example.com",
  "Name": "Иван Иванов",
  "ReplyToEmail": "reply@example.com",
  "ReturnPathDomain": "pm-bounces.example.com",
  "ConfirmationPersonalNote": "Это личное сообщение, видимое получателю, чтобы объяснить, что такое Haskimail."
}

Ответ

Domain string

Домен, связанный с подписью отправителя.

EmailAddress string

Email associated with sender signature.

ReplyToEmailAddress string

Email-адрес для ответа, связанный с подписью отправителя.

Name string

Имя отправителя в подписи.

Confirmed boolean

Указывает, подтверждена ли эта подпись отправителя.

SPFVerified boolean

Указывает, была ли когда-либо подтверждена SPF-подпись для домена.

SPFHost string

Имя хоста, используемое для конфигурации SPF.

SPFTextValue string

Значение, которое можно опционально настроить у вашего DNS-хостинга.

DKIMVerified boolean

Указывает, была ли когда-либо подтверждена DKIM-подпись для домена. Как только DKIM подтвержден, это поле останется true, даже если запись будет позже удалена из DNS.

DKIMHost string

DNS TXT-хост, используемый для валидации отправляемых сообщений.

DKIMTextValue string

Значение DNS TXT, используемое для валидации отправляемых сообщений.

DKIMPendingHost string

Если было инициировано обновление DKIM или это DKIM от новой подписи отправителя, это поле покажет ожидающий подтверждения DNS TXT-хост, который еще предстоит настроить и подтвердить у вашего регистратора или DNS-хостинга.

DKIMPendingTextValue string

Аналогично полю DKIMPendingHost, это поле покажет значение DNS TXT, ожидающее подтверждения у вашего регистратора или DNS-хостинга.

DKIMRevokedHost string

Как только новый DKIM будет подтвержден у вашего регистратора или DNS-хостинга, Haskimail отзовет старый DKIM-хост в рамках подготовки к его окончательному удалению из системы.

DKIMRevokedTextValue string

Аналогично DKIMRevokedHost, это поле покажет значение DNS TXT, которое скоро будет удалено из системы Haskimail..

SafeToRemoveRevokedKeyFromDNS boolean

Указывает, можете ли вы безопасно удалить старые DKIM DNS TXT-записи у вашего регистратора или DNS-хостинга. Новый DKIM теперь безопасно используется.

DKIMUpdateStatus string

Пока выполняются или настраиваются операции по обновлению или созданию нового DKIM, это поле будет иметь значение Pending. После того как все DNS TXT-записи будут обновлены и любые ожидающие операции обновления завершены, оно изменится на Verified.

ReturnPathDomain boolean

Пользовательский домен Return-Path для этой подписи. Для получения дополнительной информации об этом поле, пожалуйста, ознакомьтесь с нашей статьей..

ReturnPathDomainVerified boolean

Статус верификации домена Return-Path. Сообщает, используется ли Return-Path активно или все еще требует дополнительных действий для использования.

ReturnPathDomainCNAMEValue string

CNAME DNS-запись, которую Haskimail ожидает найти по адресу, указанному в ReturnPathDomain.

ID integer

Уникальный ID подписи отправителя.

ConfirmationPersonalNote string

Текст личного сообщения, отправленного получателю для подтверждения.

Пример ответа

HTTP/1.1 200 OK
Content-Type: application/json

{
  "Domain": "example.com",
  "EmailAddress": "ivan.ivanov@example.com",
  "ReplyToEmailAddress": "reply@example.com",
  "Name": "Иван Иванов",
  "Confirmed": false,
  "SPFVerified": false,
  "SPFHost": "example.com",
  "SPFTextValue": "v=spf1 a mx include:spf.mtasv.net ~all",
  "DKIMVerified": false,
  "DKIMHost": "",
  "DKIMTextValue": "",
  "DKIMPendingHost": "20140220130148.pm._domainkey.example.com",
  "DKIMPendingTextValue": "k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCQ35xZciGB0g...",
  "DKIMRevokedHost": "",
  "DKIMRevokedTextValue": "",
  "SafeToRemoveRevokedKeyFromDNS": false,
  "DKIMUpdateStatus": "Pending",
  "ReturnPathDomain": "pm-bounces.example.com",
  "ReturnPathDomainVerified": true,
  "ReturnPathDomainCNAMEValue": "pm.mtasv.net",
  "ID": 1,
  "ConfirmationPersonalNote": "Это личное сообщение, видимое получателю, чтобы объяснить, что такое Haskimail."
}

Редактирование подписи #

put

/senders/{signatureid}

Заголовки запроса

Content-Type обязательный

application/json

Accept обязательный

application/json

X-Haskimail-Account-Token обязательный

Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail.

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

curl "https://api.haskimail.ru/senders/{signatureid}" \
  -X PUT \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Haskimail-Account-Token: account token" \
  -d '{
  "Name": "Вася Пупкин",
  "ReplyToEmail": "vasya.pupkin@example.com",
  "ReturnPathDomain": "pm-bounces.example.com"
}'

Body format

Name string обязательный

Имя, которое будет связано с подписью отправителя.

ReplyToEmail string

Адрес для ответа, переопределяющий стандартный.

ReturnPathDomain string

Пользовательское значение для домена Return-Path. Это необязательное поле, но оно должно быть поддоменом вашего домена из поля FromEmail и иметь CNAME-запись, указывающую на hm.mtasv.net. Для получения дополнительной информации об этом поле, пожалуйста, ознакомьтесь с нашей статьей.

ConfirmationPersonalNote string

Необязательно. Способ предоставить получателю подтверждающего письма примечание, чтобы объяснить, что такое Haskimail. Максимальная длина 400 символов.

Пример формата тела запроса

{
  "Name": "Иван Иванов",
  "ReplyToEmail": "jane.doe@example.com",
  "ReturnPathDomain": "pm-bounces.example.com",
  "ConfirmationPersonalNote": "Это личное сообщение, видимое получателю, чтобы объяснить, что такое Haskimail."
}

Ответ

Domain string

Домен, связанный с подписью отправителя.

EmailAddress string

Email-адрес подписи отправителя.

ReplyToEmailAddress string

Email-адрес для ответа, связанный с подписью отправителя.

Name string

Имя отправителя в подписи.

Confirmed boolean

Указывает, подтверждена ли эта подпись отправителя.

SPFVerified boolean

Указывает, была ли когда-либо подтверждена SPF-подпись для домена.

SPFHost string

Имя хоста, используемое для конфигурации SPF.

SPFTextValue string

Значение, которое можно опционально настроить у вашего DNS-хостинга.

DKIMVerified boolean

Указывает, была ли когда-либо подтверждена DKIM-подпись для домена. Как только DKIM подтвержден, это поле останется true, даже если запись будет позже удалена из DNS.

DKIMHost string

DNS TXT-хост, используемый для валидации отправляемых сообщений.

DKIMTextValue string

Значение DNS TXT, используемое для валидации отправляемых сообщений.

DKIMPendingHost string

Если было инициировано обновление DKIM или это DKIM от новой подписи отправителя, это поле покажет ожидающий подтверждения DNS TXT-хост, который еще предстоит настроить и подтвердить у вашего регистратора или DNS-хостинга.

DKIMPendingTextValue string

Аналогично полю DKIMPendingHost, это поле покажет значение DNS TXT, ожидающее подтверждения у вашего регистратора или DNS-хостинга.

DKIMRevokedHost string

Как только новый DKIM будет подтвержден у вашего регистратора или DNS-хостинга, Haskimail отзовет старый DKIM-хост в рамках подготовки к его окончательному удалению из системы.

DKIMRevokedTextValue string

Аналогично DKIMRevokedHost, это поле покажет значение DNS TXT, которое скоро будет удалено из системы Haskimail..

SafeToRemoveRevokedKeyFromDNS boolean

Указывает, можете ли вы безопасно удалить старые DKIM DNS TXT-записи у вашего регистратора или DNS-хостинга. Новый DKIM теперь безопасно используется.

DKIMUpdateStatus string

Пока выполняются или настраиваются операции по обновлению или созданию нового DKIM, это поле будет иметь значение Pending. После того как все DNS TXT-записи будут обновлены и любые ожидающие операции обновления завершены, оно изменится на Verified.

ReturnPathDomain boolean

Пользовательский домен Return-Path для этой подписи. Для получения дополнительной информации об этом поле, пожалуйста, ознакомьтесь с нашей статьей..

ReturnPathDomainVerified boolean

Статус верификации домена Return-Path. Сообщает, используется ли Return-Path активно или все еще требует дополнительных действий для использования.

ReturnPathDomainCNAMEValue string

CNAME DNS-запись, которую Haskimail ожидает найти по адресу, указанному в ReturnPathDomain.

ID integer

Уникальный ID подписи отправителя.

ConfirmationPersonalNote string

Текст личного сообщения, отправленного получателю для подтверждения.

Пример ответа

HTTP/1.1 200 OK
Content-Type: application/json

{
  "Domain": "example.com",
  "EmailAddress": "ivan.ivanov@example.com",
  "ReplyToEmailAddress": "jane.doe@example.com",
  "Name": "Jane Doe",
  "Confirmed": false,
  "SPFVerified": false,
  "SPFHost": "crazydomain.com",
  "SPFTextValue": "v=spf1 a mx include:spf.mtasv.net ~all",
  "DKIMVerified": false,
  "DKIMHost": "",
  "DKIMTextValue": "",
  "DKIMPendingHost": "20140220130148.pm._domainkey.crazydomain.com",
  "DKIMPendingTextValue": "k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCQ35xZciGB0g...",
  "DKIMRevokedHost": "",
  "DKIMRevokedTextValue": "",
  "SafeToRemoveRevokedKeyFromDNS": false,
  "DKIMUpdateStatus": "Pending",
  "ReturnPathDomain": "pm-bounces.example.com",
  "ReturnPathDomainVerified": true,
  "ReturnPathDomainCNAMEValue": "pm.mtasv.net",
  "ID": 1,
  "ConfirmationPersonalNote": "Это личное сообщение, видимое получателю, чтобы объяснить, что такое Haskimail."
}

Удаление подписи #

delete

/senders/{signatureid}

Заголовки запроса

Accept обязательный

application/json

X-Haskimail-Account-Token обязательный

Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail.

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

curl "https://api.haskimail.ru/senders/{signatureid}" \
  -X DELETE \
  -H "Accept: application/json" \
  -H "X-Haskimail-Account-Token: account token"

Ответ

ErrorCode integer

Коды ошибок API

Message string

Ответ с результатом

Пример ответа

HTTP/1.1 200 OK
Content-Type: application/json

{
  "ErrorCode": 0,
  "Message": "Signature someone@example.com removed."
}

Повторная отправка подтверждения #

post

/senders/{signatureid}/resend

Заголовки запроса

Accept обязательный

application/json

X-Haskimail-Account-Token обязательный

Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail.

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

curl "https://api.haskimail.ru/senders/{signatureid}/resend" \
  -X POST \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Haskimail-Account-Token: account token"

Ответ

ErrorCode integer

Коды ошибок API

Message string

Ответ с результатом

Пример ответа

HTTP/1.1 200 OK
Content-Type: application/json

{
  "ErrorCode": 0,
  "Message": "Confirmation email for Sender Signature ivan.ivanov@example.com was re-sent."
}

Проверка SPF-записи #

post

/senders/{signatureid}/verifyspf

Запрашивает DNS вашего домена и пытается проверить, содержит ли SPF-запись информацию о серверах Haskimail.

Заголовки запроса

Content-Type обязательный

application/json

Accept обязательный

application/json

X-Haskimail-Account-Token обязательный

Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail.

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

curl "https://api.haskimail.ru/senders/{signatureid}/verifyspf" \
  -X POST \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Haskimail-Account-Token: account token"

Ответ

Поле SPFVerified SPFVerified в ответе укажет, была ли проверка SPF успешной.

Domain string

Домен, связанный с подписью отправителя.

EmailAddress string

Email-адрес, связанный с подписью отправителя.

ReplyToEmailAddress string

Email-адрес для ответа, связанный с подписью отправителя.

Name string

Имя отправителя в подписи.

Confirmed boolean

Указывает, подтверждена ли эта подпись отправителя.

SPFVerified boolean

Указывает, правильно ли настроена SPF DNS TXT-запись у вашего регистратора доменов или DNS-хостинга.

SPFHost string

Имя хоста, используемое для конфигурации SPF.

SPFTextValue string

Значение, которое можно опционально настроить у вашего DNS-хостинга.

DKIMVerified boolean

Указывает, правильно ли настроена DKIM DNS TXT-запись у вашего регистратора доменов или DNS-хостинга.

DKIMHost string

DNS TXT-хост, используемый для валидации отправляемых сообщений.

DKIMTextValue string

Значение DNS TXT, используемое для валидации отправляемых сообщений.

DKIMPendingHost string

Если было инициировано обновление DKIM или это DKIM от новой подписи отправителя, это поле покажет ожидающий подтверждения DNS TXT-хост, который еще предстоит настроить и подтвердить у вашего регистратора или DNS-хостинга.

DKIMPendingTextValue string

Аналогично полю DKIMPendingHost, это поле покажет значение DNS TXT, ожидающее подтверждения у вашего регистратора или DNS-хостинга.

DKIMRevokedHost string

Как только новый DKIM будет подтвержден у вашего регистратора или DNS-хостинга, Haskimail отзовет старый DKIM-хост в рамках подготовки к его окончательному удалению из системы.

DKIMRevokedTextValue string

Аналогично DKIMRevokedHost, это поле покажет значение DNS TXT, которое скоро будет удалено из системы Haskimail..

SafeToRemoveRevokedKeyFromDNS boolean

Указывает, можете ли вы безопасно удалить старые DKIM DNS TXT-записи у вашего регистратора или DNS-хостинга. Новый DKIM теперь безопасно используется.

DKIMUpdateStatus string

Пока выполняются или настраиваются операции по обновлению или созданию нового DKIM, это поле будет иметь значение Pending. После того как все DNS TXT-записи будут обновлены и любые ожидающие операции обновления завершены, оно изменится на Verified.

ReturnPathDomain string

Пользовательский домен Return-Path для этой подписи. Для получения дополнительной информации об этом поле, пожалуйста, ознакомьтесь с нашей статьей..

ReturnPathDomainVerified boolean

Статус верификации домена Return-Path. Сообщает, используется ли Return-Path активно или все еще требует дополнительных действий для использования.

ReturnPathDomainCNAMEValue string

CNAME DNS-запись, которую Haskimail ожидает найти по адресу, указанному в ReturnPathDomain.

ID integer

Уникальный ID подписи отправителя.

Пример ответа

HTTP/1.1 200 OK
Content-Type: application/json

{
  "Domain": "example.com",
  "EmailAddress": "ivan.ivanov@example.com",
  "ReplyToEmailAddress": "",
  "Name": "Иван Иванов",
  "Confirmed": false,
  "SPFVerified": false,
  "SPFHost": "example.com",
  "SPFTextValue": "v=spf1 a mx include:spf.mtasv.net ~all",
  "DKIMVerified": false,
  "DKIMHost": "",
  "DKIMTextValue": "",
  "DKIMPendingHost": "20140220130148.pm._domainkey.example.com",
  "DKIMPendingTextValue": "k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQCQ35xZciGB0gMm3876S...",
  "DKIMRevokedHost": "",
  "DKIMRevokedTextValue": "",
  "SafeToRemoveRevokedKeyFromDNS": false,
  "DKIMUpdateStatus": "Pending",
  "ReturnPathDomain": "pm-bounces.example.com",
  "ReturnPathDomainVerified": true,
  "ReturnPathDomainCNAMEValue": "pm.mtasv.net",
  "ID": 110396
}

Запрос нового DKIM-ключа #

post

/senders/{signatureid}/requestnewdkim

Создает новый DKIM-ключ. До тех пор, пока DNS-записи не будут подтверждены, новые значения будут находиться в полях DKIMPendingHost и DKIMPendingTextValue. После того как новое значение DKIM будет проверено в DNS, ожидающие значения переместятся в поля DKIMHost и DKIMTextValue, и Haskimail начнет подписывать письма новым DKIM-ключом.

Заголовки запроса

Content-Type обязательный

application/json

Accept обязательный

application/json

X-Haskimail-Account-Token обязательный

Для этого запроса требуются права доступа на уровне аккаунта. Этот токен доступен только владельцу аккаунта и может быть найден на вкладке «Токены API» вашего аккаунта Haskimail.

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

curl "https://api.haskimail.ru/senders/{signatureid}/requestnewdkim" \
  -X POST \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Haskimail-Account-Token: account token"

Ответ

ErrorCode integer

Коды ошибок API

Message string

Ответ с результатом

Пример ответа

HTTP/1.1 200 OK
Content-Type: application/json

{
  "ErrorCode": 505,
  "Message": "This DKIM is already being renewed."
}