Riferimento API

Domini

Crea identità mittente e interpreta lo stato della verifica DNS.

Filtra domini

POST/domains

Chiave API

Aggiungi un dominio di invio

Richiesta

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

Risposta 201

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

GET/domains

Chiave API

Elenca i domini e lo stato DNS in cache

Richiesta

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

Risposta 200

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

GET/domains/:id

Chiave API

Recupera i dettagli di configurazione del dominio

Richiesta

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

Risposta 200

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

POST/domains/:id/verify

Chiave API

Aggiorna la verifica SES e DNS

Richiesta

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

Risposta 200

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

DELETE/domains/:id

Chiave API

Elimina un dominio

Richiesta

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

Risposta 200

{
  "ok": true
}

GET/dns/provider

Chiave API

Rileva il provider DNS autoritativo e gli host relativi dei record

Rileva il provider DNS autoritativo del dominio dai nameserver attivi e restituisce l'host relativo da inserire per ogni record richiesto, il record DMARC consigliato, lo stato MX in entrata e i metodi di configurazione con un clic disponibili.

Parametri di querydomain_id

Richiesta

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

Risposta 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

Chiave API

Crea un link di consenso Domain Connect per configurare il DNS con un clic

Se il provider DNS autoritativo supporta il template Domain Connect di SendHQ, restituisce un URL di consenso firmato del provider. Una persona deve aprire l'URL e approvare la modifica presso il provider DNS; SendHQ non riceve mai credenziali DNS permanenti. Restituisce 409 se il provider non supporta il template.

Parametri di querydomain_idnext

Richiesta

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

Risposta 200

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