قائمة بدء مطوّر التكامل

يوفر وقار API مدرسياً ذا إصدار موصوفاً بالعقد الرسمي في OpenAPI. يتطلب الوصول خطة مؤهلة وميزة مفعلة للمدرسة ومفتاحاً صادراً منها ونطاقات مناسبة وأي ضابط إطلاق مطبق في المنصة. أما الكتابة فتخضع لضابط مستقل، ولا يجوز افتراضها من صلاحية القراءة.

1. اطلب من مشرف المدرسة التحقق من إتاحة API.
2. حدد أقل مجموعة من الموارد والإجراءات التي يحتاجها التكامل.
3. احصل على مفتاح مستقل بأقل نطاقات ممكنة. لا تستخدم كلمة مرور شخص أو جلسة متصفح أو مفتاح تكامل آخر.
4. احصل على العقد الحالي من /api/openapi.yaml أو استخدم توثيق API المعروض في /api/docs.
5. أبقِ عنوان الأساس والمفتاح وإعدادات البيئة خارج الشيفرة المصدرية.

قد يظهر سر المفتاح عند إنشائه فقط. خزّنه في مدير أسرار معتمد، ولا تضعه في تطبيق متصفح أو مستودع أو سجل أو صورة أو رسالة دعم أو صفحة دليل.

ابدأ بطلب قراءة صغير. أرسل ترويسة التفويض الموثقة واطلب JSON، وسجّل حالة الاستجابة ومعرّف الطلب أو التتبع من دون تسجيل أجسام حساسة. تحقق من الاستجابات مقابل مخطط OpenAPI، وعالج الترقيم حيث تعرّفه العملية.

المدرسة المرتبطة ببيانات الاعتماد هي الحد الأمني. لا تحاول تكوين معرّفات من مدرسة أخرى ولا تستنتج الوصول من معرّفات يمكن توقعها.

تتطلب عمليات الكتابة قدرة ونطاقات صريحة. في عمليات الإنشاء أو التغيير المدعومة:

• اتبع مخطط الطلب حرفياً؛
• استخدم سلوك منع التكرار الموثق؛
• لا تُعد المحاولة إلا للحالات والأساليب الموثقة على أنها آمنة؛
• احتفظ باستجابات التحقق والتعارض لمراجعة المشغّل؛
• طابق النتيجة بقراءة لاحقة عند الحاجة.

لا تحوّل رفض الكتابة إلى سلسلة طلبات غير موثقة.

• اختبر ببيانات غير إنتاجية أو بيانات اختبار معتمدة.
• عالج أخطاء المصادقة والتفويض والتحقق والتعارض والحصص والخادم كلٌّ على حدة.
• استخدم تراجعاً محدوداً واحترم معلومات الحصة أو إعادة المحاولة.
• احجب بيانات الدخول والبيانات الشخصية من الرصد.
• وثّق ملكية المفتاح وتدويره وإلغاءه والاستجابة للحوادث وإنهاء التكامل.
• اربط السلوك بالعقد المنشور، لا بحقل غير موثق ظهر في استجابة.

تظل أدلة نقاط النهاية والنطاقات والترقيم والأخطاء والحصص والكتابة خاضعة لبوابة النشر حتى تكتمل صفحاتها العربية والإنجليزية المطابقة.