مرجع 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 المعتمد ومضيفات السجلات النسبية

اكتشف مزوّد 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

إنشاء رابط موافقة Domain Connect لإعداد DNS بنقرة واحدة

عندما يدعم مزوّد DNS المعتمد قالب SendHQ لـ Domain Connect، تُعيد الواجهة عنوان 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"
}