مرجع API
النطاقات
أنشئ هويات الإرسال وافهم حالة التحقق من DNS.
لا توجد عمليات تطابق عامل التصفية هذا.
POST
مفتاح API/domainsإضافة نطاق إرسال
إضافة نطاق إرسال
curl https://sendhq.cc/api/v1/domains \
-X POST \
-H "Authorization: Bearer $SENDHQ_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"example.com"}'{
"id": "dom_…",
"name": "example.com",
"status": "pending",
"records": []
}GET
مفتاح API/domainsعرض النطاقات وحالة DNS المخزَّنة مؤقتًا
عرض النطاقات وحالة DNS المخزَّنة مؤقتًا
curl https://sendhq.cc/api/v1/domains \
-X GET \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"data": [],
"count": 0
}GET
مفتاح API/domains/:idاسترجاع تفاصيل إعداد النطاق
استرجاع تفاصيل إعداد النطاق
curl https://sendhq.cc/api/v1/domains/id_value \
-X GET \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"id": "dom_…",
"name": "example.com",
"setup_status": "checking",
"records": [],
"dns_issues": []
}POST
مفتاح API/domains/:id/verifyتحديث حالة التحقق في SES وDNS
تحديث حالة التحقق في SES وDNS
curl https://sendhq.cc/api/v1/domains/id_value/verify \
-X POST \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"domain": {
"id": "dom_…",
"status": "verified"
},
"checks": {
"ses": true
},
"status": "verified"
}DELETE
مفتاح API/domains/:idحذف نطاق
حذف نطاق
curl https://sendhq.cc/api/v1/domains/id_value \
-X DELETE \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"ok": true
}GET
مفتاح API/dns/providerاكتشاف مزوّد DNS المعتمد ومضيفات السجلات النسبية
اكتشف مزوّد DNS المعتمد للنطاق من خوادم الأسماء الحية، وأعِد المضيف النسبي الذي تُدخله لكل سجل مطلوب، وسجل DMARC الموصى به، وحالة MX للبريد الوارد، وأي طرق إعداد بنقرة واحدة متاحة.
curl https://sendhq.cc/api/v1/dns/provider \
-X GET \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"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
مفتاح API/dns/domain-connect/connectإنشاء رابط موافقة Domain Connect لإعداد DNS بنقرة واحدة
عندما يدعم مزوّد DNS المعتمد قالب SendHQ لـ Domain Connect، تُعيد الواجهة عنوان URL موقَّعًا للموافقة لدى المزوّد. يجب أن يفتح شخص هذا العنوان ويوافق على التغيير لدى مزوّد DNS؛ ولا تتلقى SendHQ أي بيانات اعتماد DNS دائمة. تُعيد 409 عندما لا يدعم المزوّد القالب.
curl https://sendhq.cc/api/v1/dns/domain-connect/connect \
-X GET \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"url": "https://dns-provider.example/v2/domainTemplates/…",
"providerName": "Example DNS"
}