التوثيق / البدء
سياسة الواجهة
كيف تُصدر Gurdx نسخ واجهتها، وتعلن عن التغييرات، وتُنهي السلوك القديم، لتتمكن من التخطيط للترقية.
التزام الاستقرار#
تلتزم Gurdx بعقد مستقر: المسارات والمعاملات وغلاف النجاح {data, status, executionTime} ورموز الأخطاء من 101 إلى 127 المُسلَّمة برمز HTTP 200. نعدّ هذا العقد مستقراً ولن نغيّره بصمت. وكل ما نضيفه فوقه يكون إضافياً: حقول جديدة، ونقاط جديدة، ورموز أخطاء جديدة (من 128 فصاعداً).
اكتب عميلك بحيث يتجاهل الحقول التي لا يعرفها، ولا تفترض أن قائمة حقول الاستجابة مغلقة.
إصدار النسخ#
تستخدم الإصدارات أرقاماً بصيغة MAJOR.MINOR.PATCH، وتُسرد في سجل التغييرات.
| النوع | محتواه | المطلوب منك |
|---|---|---|
| Patch | إصلاح أخطاء وتحسين الأداء والأمان. | لا شيء. |
| Minor | حقول أو نقاط أو وحدات أو رموز أخطاء جديدة. | لا شيء؛ اعتمدها حين يناسبك. |
| Major | تغييرات قد تكسر التكامل. | حدّث شيفرتك قبل إنهاء السلوك القديم. |
الإيقاف التدريجي#
عندما تُزمع إزالة ميزة أو حقل أو نسخة:
- نعلن ذلك في التوثيق وبالبريد لأصحاب الحسابات وفي لوحة التحكم.
- نمنح مهلة لا تقل عن شهرين لأي إزالة قد تؤثر على تكامل يعمل.
- بعد انتهاء المهلة قد يتوقف السلوك القديم. الاستثناء هو الإصلاحات الأمنية التي قد تُطبَّق فوراً.
الاستخدام العادل#
استخدم الواجهة لتطبيقك أنت. لا تعِد بيع الوصول الخام، ولا تفحص الخدمة بحثاً عن ثغرات، ولا تحاول الالتفاف على الحصة أو حد الإغراق أو قيد المضيفين المصرّح لهم. قد تُعلَّق الحسابات المسيئة (الخطأ 102). الحدود موضّحة في حدود الاستخدام.
التعامل مع البيانات#
- تُحفظ سجلات الطلبات الخام لمدة محدودة، أما عدّادات الاستخدام فتُحفظ مدة أطول.
- لا تُخزَّن أرقام البطاقات إطلاقاً.
- يمكنك طلب حذف بيانات المستخدمين النهائيين عبر حذف بيانات مستخدم.
الدعم والإشعارات#
تُرسل الإشعارات المهمة إلى بريد مالك الحساب، فأبقِه محدّثاً في لوحة التحكم (https://gurdx.cretip.com/app). وإذا لاحظت سلوكاً يخالف هذا التوثيق فبلّغ الدعم مع رابط الطلب (دون المفتاح) ومحتوى الاستجابة.
وجدت خطأ؟ أخبرنا عبر صفحة التواصل. تواصل معنا