Referência da API

Domínios

Provisione identidades de remetente e entenda o estado da verificação de DNS.

Filtrar domínios

POST/domains

Chave de API

Adicionar um domínio de envio

Requisição

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

Resposta 201

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

GET/domains

Chave de API

Listar domínios e o estado de DNS em cache

Requisição

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

Resposta 200

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

GET/domains/:id

Chave de API

Obter os detalhes de configuração de um domínio

Requisição

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

Resposta 200

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

POST/domains/:id/verify

Chave de API

Atualizar a verificação no SES e no DNS

Requisição

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

Resposta 200

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

DELETE/domains/:id

Chave de API

Excluir um domínio

Requisição

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

Resposta 200

{
  "ok": true
}

GET/dns/provider

Chave de API

Detectar o provedor de DNS autoritativo e os hosts relativos dos registros

Detecta o provedor de DNS autoritativo do domínio a partir dos nameservers ativos e retorna o host relativo a informar em cada registro obrigatório, o registro DMARC recomendado, o estado do MX de entrada e quais métodos de configuração com um clique estão disponíveis.

Parâmetros de querydomain_id

Requisição

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

Resposta 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

Chave de API

Criar um link de consentimento do Domain Connect para configurar o DNS com um clique

Quando o provedor de DNS autoritativo oferece suporte ao template Domain Connect do SendHQ, retorna uma URL de consentimento assinada do provedor. Uma pessoa precisa abrir a URL e aprovar a alteração no provedor de DNS; o SendHQ nunca recebe credenciais de DNS permanentes. Retorna 409 quando o provedor não oferece suporte ao template.

Parâmetros de querydomain_idnext

Requisição

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

Resposta 200

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