ابدأ من هنا
الإصدارات وإيقاف الدعم
افهم إصدارات URL الرئيسية والإضافات المتوافقة وإشعارات الإيقاف ونوافذ الإنهاء.
المسارات الرئيسية المستقرة
تستخدم تكاملات العملاء إصدارًا رئيسيًا في URL، هو حاليًا /api/v1. ويحدد info.version في OpenAPI المبني على التاريخ العقد المنشور بدقة ضمن ذلك الإصدار الرئيسي.
التغييرات المتوافقة
قد تضيف SendHQ حقول طلب اختيارية وحقول استجابة وقيم enum حيث يسمح المخطط بذلك، وعمليات جديدة ضمن v1. وينبغي للعملاء تجاهل حقول الاستجابة غير المعروفة وتجنب معاملة enum كمجموعة مغلقة نهائيًا ما لم ينص المخطط على ذلك.
التغييرات الجذرية
يتطلب أي تغيير جذري في الطلب أو الاستجابة أو المصادقة أو السلوك مسارًا رئيسيًا جديدًا مثل /api/v2 ووثائق ترحيل وانتقالًا معلَنًا. وواجهة v1 API الحالية غير مهجورة.
الإيقاف والإنهاء
عندما يُوقَف دعم إصدار، توثّق SendHQ البديل ومسار الترحيل وتعيد الترويستين Deprecation وSunset حيثما ينطبق. وتظل الإصدارات الموقوف دعمها متاحة 90 يومًا على الأقل بعد تاريخ الإيقاف المنشور ما لم يُنشئ استمرار التشغيل خطرًا أمنيًا أو قانونيًا عاجلًا.