إدارة إصدارات API والتطبيق

تعالج إصدارات مسار API وإصدارات تطبيق السوق مشكلتين مختلفتين. عقد HTTP العام الحالي هو /api/v1، كما ينشر كل تطبيق في السوق إصدارات دلالية خاضعة للمراجعة.

API v1

لا تنتمي إلى عقد API v1 الحالي إلا العمليات الخمس الموثقة. تعد الجداول وRPCs والمخططات والمسارات الداخلية تفاصيل تنفيذ غير مرتبطة بإصدار من منظور المطور الخارجي. لا ترتبط بها.

إصدارات التطبيق

لكل إصدار تطبيق عناوين إعادة توجيه محددة ونطاقات مطلوبة وتصريحات Webhook وملاحظات إصدار وحالة مراجعة ونشر. تنطبق المراجعة والموافقة على ذلك الإصدار بعينه. تبقى التثبيتات القائمة مرتبطة به حتى ينفذ التاجر ترقية أو إعادة تفويض مدعومة.

التغييرات المتوافقة

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

حالة حوكمة الإهمال

فترات الإشعار الرسمية وسياسة الإيقاف ونوافذ دعم التوافق PLANNED. لا يوجد موعد إهمال عام موعود حالياً. حتى نشر الحوكمة، يكون سجل التغييرات هو السجل العام المعتمد، ولا تدعي المنصة سياسة لم تعتمدها.

حالة أدلة الترحيل

أدلة الترحيل PLANNED لأنه لا يوجد إصدار API عام تاريخي للانتقال منه. سينشر دليل عند وجود مسار ترحيل فعلي ومتوافق؛ ويجب ألا يختلق المحتوى المستقبلي إصدارات أو تواريخ.