Справочник API

Домены

Настройка адресов отправителя и состояние подтверждения DNS.

Фильтр операций с доменами

POST/domains

API-ключ

Добавить домен отправки

Запрос

curl https://sendhq.cc/api/v1/domains \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"example.com"}'

Ответ 201

{
  "id": "dom_…",
  "name": "example.com",
  "status": "pending",
  "records": []
}

GET/domains

API-ключ

Список доменов и кешированное состояние DNS

Запрос

curl https://sendhq.cc/api/v1/domains \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

Ответ 200

{
  "data": [],
  "count": 0
}

GET/domains/:id

API-ключ

Получить параметры настройки домена

Запрос

curl https://sendhq.cc/api/v1/domains/id_value \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

Ответ 200

{
  "id": "dom_…",
  "name": "example.com",
  "setup_status": "checking",
  "records": [],
  "dns_issues": []
}

POST/domains/:id/verify

API-ключ

Обновить статус подтверждения в SES и DNS

Запрос

curl https://sendhq.cc/api/v1/domains/id_value/verify \
  -X POST \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

Ответ 200

{
  "domain": {
    "id": "dom_…",
    "status": "verified"
  },
  "checks": {
    "ses": true
  },
  "status": "verified"
}

DELETE/domains/:id

API-ключ

Удалить домен

Запрос

curl https://sendhq.cc/api/v1/domains/id_value \
  -X DELETE \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

Ответ 200

{
  "ok": true
}

GET/dns/provider

API-ключ

Определить авторитетного DNS-провайдера и относительные хосты записей

Определяет авторитетного DNS-провайдера домена по действующим NS-серверам и возвращает относительный хост для каждой обязательной записи, рекомендуемую DMARC-запись, состояние входящей MX-записи и доступные способы настройки в один клик.

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

Запрос

curl https://sendhq.cc/api/v1/dns/provider \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

Ответ 200

{
  "detectionStatus": "confirmed",
  "detected": "cloudflare",
  "zone": "example.com",
  "nameservers": [
    "ada.ns.cloudflare.com"
  ],
  "recordHosts": {},
  "inbound": {
    "available": true,
    "domain": null,
    "status": "not_configured",
    "record": null
  },
  "recommendations": [],
  "authentication": {},
  "providers": {
    "domainConnect": {
      "available": false,
      "providerName": null
    }
  }
}

GET/dns/domain-connect/connect

API-ключ

Создать ссылку согласия Domain Connect для настройки DNS в один клик

Если авторитетный DNS-провайдер поддерживает шаблон Domain Connect от SendHQ, возвращает подписанный URL согласия у провайдера. Человек должен открыть этот URL и одобрить изменение у DNS-провайдера; SendHQ никогда не получает постоянных учётных данных для DNS. Возвращает 409, если провайдер не поддерживает шаблон.

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

Запрос

curl https://sendhq.cc/api/v1/dns/domain-connect/connect \
  -X GET \
  -H "Authorization: Bearer $SENDHQ_API_KEY"

Ответ 200

{
  "url": "https://dns-provider.example/v2/domainTemplates/…",
  "providerName": "Example DNS"
}