API-referentie

Domeinen

Richt afzenderidentiteiten in en begrijp de status van de DNS-verificatie.

Domeinen filteren

POST/domains

API-sleutel

Een verzenddomein toevoegen

Request

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-respons

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

GET/domains

API-sleutel

Domeinen en gecachte DNS-status opvragen

Request

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

200-respons

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

GET/domains/:id

API-sleutel

Configuratiegegevens van een domein ophalen

Request

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

200-respons

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

POST/domains/:id/verify

API-sleutel

SES- en DNS-verificatie vernieuwen

Request

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

200-respons

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

DELETE/domains/:id

API-sleutel

Een domein verwijderen

Request

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

200-respons

{
  "ok": true
}

GET/dns/provider

API-sleutel

De gezaghebbende DNS-provider en relatieve recordhosts detecteren

Detecteer de gezaghebbende DNS-provider van het domein via de live nameservers, en krijg de relatieve host terug die je voor elk vereist record moet invullen, het aanbevolen DMARC-record, de status van het inkomende MX-record en welke methoden voor configuratie met één klik beschikbaar zijn.

Queryparametersdomain_id

Request

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

200-respons

{
  "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-sleutel

Een Domain Connect-toestemmingslink maken voor DNS-configuratie met één klik

Als de gezaghebbende DNS-provider de Domain Connect-template van SendHQ ondersteunt, krijg je een ondertekende toestemmings-URL van de provider terug. Iemand moet die URL openen en de wijziging bij de DNS-provider goedkeuren; SendHQ krijgt nooit blijvende DNS-credentials. Geeft 409 terug als de provider de template niet ondersteunt.

Queryparametersdomain_idnext

Request

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

200-respons

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