مرجع API

دامنه‌ها

هویت‌های فرستنده را ایجاد کنید و وضعیت تأیید 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

فهرست دامنه‌ها و وضعیت ذخیره‌شده 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

به‌روزرسانی تأیید 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 معتبر (authoritative) و hostهای نسبی رکوردها

ارائه‌دهنده DNS معتبر (authoritative) دامنه را از nameserverهای فعلی تشخیص می‌دهد و host نسبی‌ای را که باید برای هر رکورد لازم وارد شود، رکورد DMARC پیشنهادی، وضعیت MX ورودی و روش‌های راه‌اندازی یک‌کلیکی در دسترس را برمی‌گرداند.

پارامترهای querydomain_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

ساخت لینک رضایت Domain Connect برای راه‌اندازی یک‌کلیکی DNS

اگر ارائه‌دهنده DNS معتبر از قالب Domain Connect ‏SendHQ پشتیبانی کند، یک URL رضایت امضاشده از ارائه‌دهنده برمی‌گرداند. یک شخص باید URL را باز کند و تغییر را نزد ارائه‌دهنده DNS تأیید کند؛ SendHQ هرگز اعتبارنامه دائمی DNS دریافت نمی‌کند. اگر ارائه‌دهنده از این قالب پشتیبانی نکند، 409 برمی‌گرداند.

پارامترهای querydomain_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"
}