Referencia de la API

Dominios

Aprovisione identidades de remitente y conozca el estado de la verificación de DNS.

Filtrar dominios

POST/domains

Clave de API

Agregar un dominio de envío

Solicitud

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

Respuesta 201

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

GET/domains

Clave de API

Listar dominios y el estado DNS en caché

Solicitud

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

Respuesta 200

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

GET/domains/:id

Clave de API

Obtener los detalles de configuración de un dominio

Solicitud

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

Respuesta 200

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

POST/domains/:id/verify

Clave de API

Actualizar la verificación de SES y DNS

Solicitud

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

Respuesta 200

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

DELETE/domains/:id

Clave de API

Eliminar un dominio

Solicitud

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

Respuesta 200

{
  "ok": true
}

GET/dns/provider

Clave de API

Detectar el proveedor de DNS autoritativo y los hosts relativos de los registros

Detecta el proveedor de DNS autoritativo del dominio a partir de los servidores de nombres en vivo y devuelve el host relativo que hay que introducir para cada registro obligatorio, el registro DMARC recomendado, el estado del MX de entrada y qué métodos de configuración con un clic están disponibles.

Parámetros de consultadomain_id

Solicitud

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

Respuesta 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

Clave de API

Crear un enlace de consentimiento de Domain Connect para la configuración DNS con un clic

Cuando el proveedor de DNS autoritativo admite la plantilla Domain Connect de SendHQ, devuelve una URL de consentimiento firmada del proveedor. Una persona debe abrir la URL y aprobar el cambio en el proveedor de DNS; SendHQ nunca recibe credenciales de DNS permanentes. Devuelve 409 cuando el proveedor no admite la plantilla.

Parámetros de consultadomain_idnext

Solicitud

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

Respuesta 200

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