الإصدارات والإيقاف التدريجي
كيف نحدد إصدارات API ونطرح التغييرات ونرسل إشعارات قبل التغييرات غير المتوافقة أو عمليات الإزالة.
إصدارات API وSDK
يُحدَّد إصدار REST API في المسار: /v1. لا توجد ترويسة للإصدار. ويتفاوض MCP على المسار /mcp على إصدار بروتوكوله الخاص.
إصدارات حزم SDK مستقلة عن إصدار API.
التغييرات المتوافقة
يمكننا ضمن /v1 إضافة نقاط نهاية وأدوات MCP ومجموعات بيانات وبلدان أو تغطية، ومدخلات اختيارية تُبقي السلوك الحالي كما هو. قد نطرح هذه التغييرات في أي وقت دون إشعار.
يمكننا أيضًا إضافة حقول استجابة اختيارية أو تقبل القيمة null، وقيم جديدة في تعداد الاستجابة، دون إشعار. ندرج هذه التغييرات في سجل التغييرات.
ينبغي للعملاء تجاهل الحقول التي لا يعرفونها وقبول قيم التعداد التي لا يعرفونها. تتبع حزم SDK الخاصة بنا هذا السلوك بالفعل.
التغييرات غير المتوافقة
إزالة حقل أو تغيير اسمه تغيير غير متوافق. وكذلك تغيير نوعه أو معناه أو وحدته أو دقته أو كونه مطلوبًا.
تغيير مسار أو طريقة طلب، أو المصادقة أو التفويض أو الحصة أو السلوك الافتراضي، يُعد أيضًا تغييرًا غير متوافق.
نطرح التغيير غير المتوافق في مسار أو عملية جديدة، أو في إصدار رئيسي جديد. لا نغيّر المسار أو العملية أو الإصدار الحالي دون إعلان.
الإشعار قبل التغييرات
إذا أثّر تغيير غير متوافق أو عملية إزالة على نقطة نهاية أو حقل استدعاه حسابك خلال آخر 90 يومًا، فنبلغك قبل سريانه بثلاثة أشهر على الأقل. نرسل الإشعار عبر البريد الإلكتروني وننشره في سجل التغييرات.
قد نزيل نقاط النهاية أو الحقول التي لم يستدعها أي حساب خلال آخر 90 يومًا بمهلة إشعار أقصر. نعلن عن عمليات الإزالة هذه في سجل التغييرات.
أين نعلن عن التغييرات
نعلن عن التغييرات في سجل التغييرات وخلاصة RSS الخاصة به.
ما يُنصح بالتوقف عن استخدامه حاليًا
الحقل event_type في الأحداث الاقتصادية اسم بديل للحقل type ويُنصح بالتوقف عن استخدامه. استخدم type.
لم يُحدَّد موعد للإزالة. وعندما نحدده، سنتبع سياسة الإشعار الموضحة أعلاه.
التوثيق