التكامل مع API وقار v1

API وقار v1 واجهة JSON بين الخوادم لمدرسة واحدة. يحدد مفتاح API المدرسة؛ ولا يرسل العميل معرّف مدرسة لاختيار المستأجر.

• عنوان الأساس: https://waqar.app/api/v1
• العقد المقروء آلياً: https://waqar.app/api/openapi.yaml
• العقد المعروض: https://waqar.app/api/docs
• أوقات الطلب والاستجابة: RFC 3339 بتوقيت UTC
• شكل النجاح: عضو data أعلى الاستجابة، ومعه pagination للمجموعات
• شكل الخطأ: كائن error أعلى الاستجابة

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

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

الكتابة قدرة مستقلة لها إطلاق ونطاقات منفصلة. ولا تتاح لمجرد نجاح القراءة أو وجود خطة Enterprise.

1. حدد الموارد وإجراءات القراءة أو الكتابة المطلوبة بدقة.
2. اطلب من مشرف المدرسة مفتاحاً مستقلاً بأقل نطاقات.
3. خزّن بيانات الاعتماد التي تظهر مرة واحدة في مدير أسرار.
4. تحقق من عقد OpenAPI الحالي في مسار البناء.
5. ابدأ بـ GET /school للتحقق من مدرسة بيانات الاعتماد.
6. نفّذ ترقيم اللقطات والمزامنة التزايدية حيث تعرفهما العملية.
7. عالج رموز الأخطاء الثابتة ومعرّفات الطلب وترويسات الحصة وRetry-After.
8. لا تضف الكتابة إلا بعد اعتماد القدرة صراحة، واستخدم قواعد منع التكرار.
9. دوّر المفاتيح وألغها عبر ملكية مسماة.

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

تابع إلى مفاتيح API و المصادقة والنطاقات و مرجع نقاط النهاية.