API 레퍼런스

도메인

발신 ID를 프로비저닝하고 DNS 검증 상태를 파악합니다.

도메인 필터

POST/domains

API 키

발신 도메인 추가

요청

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 응답

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

GET/domains

API 키

도메인과 캐시된 DNS 상태 조회

요청

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

200 응답

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

GET/domains/:id

API 키

도메인 설정 세부 정보 조회

요청

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

200 응답

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

POST/domains/:id/verify

API 키

SES 및 DNS 검증 새로 고침

요청

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

200 응답

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

DELETE/domains/:id

API 키

도메인 삭제

요청

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

200 응답

{
  "ok": true
}

GET/dns/provider

API 키

권한 있는 DNS 제공업체와 상대 레코드 호스트 감지

실시간 네임서버에서 도메인의 권한 있는 DNS 제공업체를 감지하고, 필요한 모든 레코드에 입력할 상대 호스트, 권장 DMARC 레코드, 수신 MX 상태, 사용할 수 있는 원클릭 설정 방법을 반환합니다.

쿼리 매개변수domain_id

요청

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

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

API 키

원클릭 DNS 설정을 위한 Domain Connect 동의 링크 생성

권한 있는 DNS 제공업체가 SendHQ Domain Connect 템플릿을 지원하면 서명된 제공업체 동의 URL을 반환합니다. 사용자가 직접 URL을 열어 DNS 제공업체에서 변경을 승인해야 하며, SendHQ는 상시 DNS 자격 증명을 받지 않습니다. 제공업체가 템플릿을 지원하지 않으면 409를 반환합니다.

쿼리 매개변수domain_idnext

요청

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

200 응답

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