Référence de l’API

Domaines

Provisionnez des identités d’expéditeur et suivez l’état de la vérification DNS.

Filtrer les domaines

POST/domains

Clé API

Ajouter un domaine d’envoi

Requête

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

Réponse 201

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

GET/domains

Clé API

Lister les domaines et l’état DNS en cache

Requête

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

Réponse 200

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

GET/domains/:id

Clé API

Récupérer les détails de configuration d’un domaine

Requête

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

Réponse 200

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

POST/domains/:id/verify

Clé API

Actualiser la vérification SES et DNS

Requête

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

Réponse 200

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

DELETE/domains/:id

Clé API

Supprimer un domaine

Requête

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

Réponse 200

{
  "ok": true
}

GET/dns/provider

Clé API

Détecter le fournisseur DNS faisant autorité et les hôtes relatifs des enregistrements

Détecte le fournisseur DNS faisant autorité pour le domaine à partir des serveurs de noms en production, et renvoie l’hôte relatif à saisir pour chaque enregistrement requis, l’enregistrement DMARC recommandé, l’état du MX entrant et les méthodes de configuration en un clic disponibles.

Paramètres de requêtedomain_id

Requête

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

Réponse 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

Clé API

Créer un lien de consentement Domain Connect pour configurer le DNS en un clic

Lorsque le fournisseur DNS faisant autorité prend en charge le modèle Domain Connect de SendHQ, renvoie une URL de consentement signée du fournisseur. Une personne doit ouvrir cette URL et approuver la modification chez le fournisseur DNS ; SendHQ ne reçoit jamais d’identifiants DNS permanents. Renvoie 409 si le fournisseur ne prend pas en charge le modèle.

Paramètres de requêtedomain_idnext

Requête

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

Réponse 200

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