Если вы отправляете письма с множества доменов или постоянно добавляете новые, Domains API — мощный инструмент, который сэкономит вам время. С его помощью вы можете программно:
-
добавлять домены в свой аккаунт HaskiMail,
-
получать данные для настройки DKIM и SPF-записей,
Ниже рассмотрены основные сценарии использования.
Добавление и настройка домена
Вызов Create a domain позволяет быстро добавить домен в ваш аккаунт.
Метод: POST
Endpoint: https://api.haskimail.ru/domains/
Пример тела запроса:
{
Name: domain.com,
ReturnPathDomain: pm-bounces.domain.com
}
После вызова API вы получите данные для настройки нового домена, в том числе записи DNS для настройки DKIM и SPF:
{
"ID":75772,
"Name":"naprimer.ru",
"DKIMVerified":false,
"WeakDKIM":false,
"SPFVerified":false,
"ReturnPathDomainVerified":false,
"SPFTextValue":{"valid":0,"name":"naprimer.ru.","record_type":"TXT","value":"v=spf1
include:_spf.dashasender.ru
~all"},
"DKIMTextValue":{"valid":0,"name":"dm._domainkey.naprimer.ru.","record_type":"TXT","value":"v=DKIM1;p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC\/kvGODjzpbZRh01jx8O0NrUe14VGqMVznA0HFSTLnf5pVO6Go5WSOsNRJrNCoNzIBFwAZuu94yFZVsWe0585SscYhcu1\/UO9J9KQH+fBy8jj9UfIrKJ7rfrBbicNLjcXpAUydVQC\/Homxh6pkbL96OQYgC35aP5rtfLEM6WtDxwIDAQAB;t=s"}}
Использование данных DKIM и SPF
Значения SPFTextValue и DKIMTextValue — это имена и значения TXT-записей, которые нужно добавить в DNS, чтобы завершить настройку DKIM и SPF.
Например:
Имя: dm._domainkey.naprimer.ru
Значение: v=DKIM1;p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC\/kvGODjzpbZRh01jx8O0NrUe14VGqMVznA0HFSTLnf5pVO6Go5WSOsNRJrNCoNzIBFwAZuu94yFZVsWe0585SscYhcu1\/UO9J9KQH+fBy8jj9UfIrKJ7rfrBbicNLjcXpAUydVQC\/Homxh6pkbL96OQYgC35aP5rtfLEM6WtDxwIDAQAB;t=s
Удаление домена
Если клиент больше не пользуется вашей платформой, вы можете удалить его домен программно с помощью вызова Delete a Domain.
Метод: DELETE
Endpoint: https://api.haskimail.ru/domains/{domainid}
Тело запроса не требуется. Ответ будет таким:
{
ErrorCode: 0,
Message: Domain domain removed.
}