singlefax
اللغة

إصدارات واجهة API من SingleFax وإيقاف الإصدارات القديمة

يمكن للوكلاء والأنظمة الخلفية الاعتماد على هذه السياسة. الواجهة الحالية لخدمة REST هي /api/v1. لم يُحدد موعد لإيقافها.

إدارة الإصدارات

واجهة REST API العامة مُرقّمة الإصدار في مسار URL: ‏https://singlefax.com/api/v1/… والمسارات نفسها على api.singlefax.com. تتوفر OpenAPI على /openapi.json مع تطابق info.version مع الإصدار الرئيسي في المسار (حاليًا 1.0.0).

تبقى الإضافات المتوافقة مع الإصدارات السابقة (حقول اختيارية جديدة، أو نقاط نهاية جديدة، أو قيم data.code جديدة للأخطاء) ضمن v1 دون ترويسة. أما التغييرات غير المتوافقة أو حذف الحقول أو تغيير أنواعها أو إضافة متطلبات مصادقة إلزامية، فتُطرح في /api/v2. لا نغيّر بنية طلبات v1 أو ردودها بصمت.

إيقاف الإصدارات القديمة وإنهاء دعمها

عند التخطيط لإزالة عملية أو حقل في v1، تتضمن استجابات تلك العملية Deprecation وفق RFC 8594 (تاريخ وسمها بذلك) وSunset وفق RFC 8594 (تاريخ توقفها عن العمل). لا يحين Sunset إلا بعد 90 يومًا على الأقل من Deprecation. ويضع OpenAPI على العمليات نفسها العلامة deprecated: true.

لا تحمل أي عملية v1 حاليًا ترويسة Deprecation أو Sunset. ويخضع MCP Streamable HTTP على /mcp لمهلة الإشعار نفسها عند إزالة أداة.

أين يمكن قراءة هذا آليًا