مرجع API
الحساب والفوترة
اقرأ استخدام الحساب والتحليلات والبيانات الوصفية للمفاتيح باستخدام مفتاح API؛ أما تغييرات الفوترة وإنشاء المفاتيح أو إلغاؤها فتتطلب جلسة لوحة تحكم.
لا توجد عمليات تطابق عامل التصفية هذا.
/accountاسترجع الحساب والاستخدام وحالة الفوترة وأعداد مساحات العمل باستخدام مفتاح API
المكافئ عبر مفتاح API لملف لوحة التحكم الشخصي: مالك الحساب، واستخدام المستلِمين والمرفقات في الفترة الحالية مقابل حدود الباقة، ومستوى الوصول، وملخص سمعة المُرسِل، وحالة الاشتراك، والباقات المنشورة، وأعداد مساحات العمل. للقراءة فقط؛ وتبقى تغييرات الفوترة عبر الجلسة فقط.
curl https://sendhq.cc/api/v1/account \
-X GET \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"user": {},
"usage": {},
"access": {},
"reputation": {},
"infrastructure": {},
"billing": {},
"plans": [],
"workspace": {
"mailer": "ses",
"stats": {}
}
}/analyticsاسترجع تحليلات الإرسال في لوحة التحكم لمدة 7 أو 30 أو 90 يومًا
إجماليات الرسائل المرسَلة والمستلَمة والمسلَّمة والمرتدة والمحظورة والمفتوحة والمنقورة والشكاوى خلال النافذة، وخطًا زمنيًا يوميًا للمرسَل/المستلَم، وأهم نطاقات الإرسال، وأفضل الموضوعات أداءً.
curl https://sendhq.cc/api/v1/analytics \
-X GET \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"window": "30d",
"days": 30,
"metrics": {
"sent": 0,
"received": 0,
"bounced": 0,
"blocked": 0,
"delivered": 0,
"opened": 0,
"clicks": 0,
"complaints": 0
},
"timeline": [],
"domains": [],
"topContent": []
}/profileاسترجع الحساب والاستخدام وحالة الاشتراك المتراكم
استرجع الحساب والاستخدام وحالة الاشتراك المتراكم
curl https://sendhq.cc/api/v1/profile \
-X GET \
-H "Cookie: sendhq_session_v2=…"{
"user": {},
"usage": {},
"access": {},
"reputation": {},
"billing": {},
"plans": []
}/billing/checkoutابدأ عملية دفع مستضافة لباقة لا تملكها بالفعل (المستوى وفئة الرسائل ودورة الفوترة)
ابدأ عملية دفع مستضافة لباقة لا تملكها بالفعل (المستوى وفئة الرسائل ودورة الفوترة)
curl https://sendhq.cc/api/v1/billing/checkout \
-X POST \
-H "Cookie: sendhq_session_v2=…" \
-H "Content-Type: application/json" \
-d '{"plan_key":"scaleup_marketing_annual"}'{
"url": "https://checkout.example/…",
"session_id": "…"
}/billing/cancelألغِ الاشتراك الحالي داخل التطبيق دون المساس بالمزوّد
ألغِ الاشتراك الحالي داخل التطبيق دون المساس بالمزوّد
curl https://sendhq.cc/api/v1/billing/cancel \
-X POST \
-H "Cookie: sendhq_session_v2=…"{
"ok": true
}/keysأنشئ مفتاح API
أنشئ مفتاح API
curl https://sendhq.cc/api/v1/keys \
-X POST \
-H "Cookie: sendhq_session_v2=…" \
-H "Content-Type: application/json" \
-d '{"name":"Production"}'{
"id": "key_…",
"name": "Production",
"key": "re_…",
"prefix": "re_…"
}/keysاعرض البيانات الوصفية لمفاتيح API
اعرض أسماء المفاتيح وبادئاتها غير السرية وأوقات آخر استخدام. ولا تُعاد قيم المفاتيح الكاملة أبدًا. ويتطلب إنشاء المفاتيح وإلغاؤها جلسة لوحة تحكم.
curl https://sendhq.cc/api/v1/keys \
-X GET \
-H "Authorization: Bearer $SENDHQ_API_KEY"{
"data": [],
"count": 0
}/keys/:idألغِ مفتاح API
ألغِ مفتاح API
curl https://sendhq.cc/api/v1/keys/id_value \
-X DELETE \
-H "Cookie: sendhq_session_v2=…"{
"ok": true
}