عقد واحد للواجهة الكاملة المخصصة للعملاء.

حدود المصادقة

تستخدم تكاملات المنتج مفتاح API لمساحة العمل، ويمكنه أيضًا قراءة استخدام الحساب والتحليلات وبيانات وصفية لمفاتيح API. أما تغييرات الفوترة وإنشاء مفاتيح API أو إلغاؤها فتتطلب جلسة المتصفح المقتصرة على HTTP وهي موسومة وفق ذلك.

الموارد

غلاف الأخطاء

تستخدم أخطاء JSON غلافًا واحدًا متوقَّعًا. وتميّز رموز الحالة بين المُدخلات غير الصالحة والمصادقة والموارد المفقودة والتعارضات ومتطلبات الدفع وحواجز الأمان وحدود الاستخدام.

{
  "error": {
    "message": "The sender domain is not verified",
    "status": 403
  }
}

الإصدارات

يحدد إصدار API المبني على التاريخ هذا العقد. ويمكن إضافة حقول متوافقة مع الإصدارات السابقة ضمن الإصدار نفسه. أما التغييرات الجذرية فتتطلب مسارًا أساسيًا جديدًا ذا إصدار وانتقالًا موثَّقًا.

{
  "version": "2026-09-07",
  "baseUrl": "https://sendhq.cc/api/v1",
  "openapi": "https://sendhq.cc/openapi.json"
}