Аккаунт
Выйти

Обзор

Интеграции

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

Справочник API

Вебхуки

API Доменов

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

Список доменов #

get

/domains

Получает список доменов с общей информацией и статусом аутентификации.

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

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

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

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

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

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

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

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

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

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

Ответ

TotalCount integer

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

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

Название домена.
SPFVerified boolean

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

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

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

Уникальный ID домена.

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

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

{
  "TotalCount": 2,
  "Domains": [
    {
      "Name": "haskimail.ru",
      "SPFVerified": true,
      "DKIMVerified": true,
      "ReturnPathDomainVerified": false,
      "ID": 36735
    },
    {
      "Name": "example.com",
      "SPFVerified": true,
      "DKIMVerified": true,
      "ReturnPathDomainVerified": true,
      "ID": 81605
    }
  ]
}

Получение информации о домене #

get

/domains/{domainid}

Получает всю информацию о конкретном домена./p>

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

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

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

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

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

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

Ответ

Name string

Название домена.
SPFVerified boolean

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

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

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

DKIMVerified boolean

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

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

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

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

Уникальный ID домена.

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

HTTP/1.1 200 OK
Content-Type: application/json
{
  "Name": "haskimail.ru",
  "SPFVerified": true,
  "SPFHost": "haskimail.ru",
  "SPFTextValue": "v=spf1 a mx include:spf.mtasv.net ~all",
  "DKIMVerified": false,
  "WeakDKIM": false,
  "DKIMHost": "jan2013pm._domainkey.haskimail.ru",
  "DKIMTextValue": "k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDJ...",
  "ReturnPathDomainVerified": false,
  "ID": 36735
}

Создание домена #

post

/domains

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

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

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

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

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

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

curl "https://api.haskimail.ru/domains" \
  -X POST \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Haskimail-Account-Token: account token" \
  -d '{
  "Name": "example.com"
}'

Формат тела запроса

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

Название домена.

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

{
  "Name": "example.com"
}

Ответ

Name string

Название домена.
SPFVerified boolean

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

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

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

DKIMVerified boolean

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

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

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

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

Уникальный ID домена.

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

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

{
  "Name": "newdomain.com",
  "SPFVerified": false,
  "SPFHost": "newdomain.com",
  "SPFTextValue": "v=spf1 a mx include:spf.mtasv.net ~all",
  "DKIMVerified": false,
  "WeakDKIM": false,
  "DKIMHost": "",
  "DKIMTextValue": "",
  "ReturnPathDomainVerified": false,
  "ID": 36736
}

Удаление домена #

delete

/domains/{domainid}

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

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

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

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

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

curl "https://api.haskimail.ru/domains/{domainid}" \
  -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": "Domain example.com removed."
}

Проверка статуса DKIM #

put

/domains/{domainid}/verifyDkim

Проверить DKIM-ключи для указанного домена.

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

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

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

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

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

curl "https://api.haskimail.ru/domains/{domainid}/verifyDkim" \
  -X PUT \
  -H "Accept: application/json" \
  -H "X-Haskimail-Account-Token: account token" \
  -d ""

Ответ

Name string

Название домена.
SPFVerified boolean

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

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

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

DKIMVerified boolean

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

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

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

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

Уникальный ID домена.

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

HTTP/1.1 200 OK
Content-Type: application/json
{
  "Name": "haskimail.ru",
  "SPFVerified": true,
  "SPFHost": "haskimail.ru",
  "SPFTextValue": "v=spf1 a mx include:spf.mtasv.net ~all",
  "DKIMVerified": false,
  "WeakDKIM": false,
  "DKIMHost": "jan2013pm._domainkey.haskimail.ru",
  "DKIMTextValue": "k=rsa; p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDJ...",
  "ReturnPathDomainVerified": false,
  "ID": 36735
}

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

post

/domains/{domainid}/verifyspf

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

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

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

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

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

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

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

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

Ответ

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

SPFHost string

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

Текстовая DNS-запись SPF правильно настроена у вашего регистратора домена или DNS-хостинга.
SPFTextValue string

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

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

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

{
  "SPFHost": "example.com",
  "SPFVerified": true,
  "SPFTextValue": "v=spf1 a mx include:spf.mtasv.net ~all"
}