استخدم ManageBac+ Public API لتوصيل الأنظمة الأخرى. قم بإنشاء وإدارة الرموز المميزة لواجهة برمجة التطبيقات (API) وابحث عن الحقول والأذونات المدعومة.
تعرف على كيفية عمل ManageBac+ public API، وكيفية إنشاء الرموز المميزة لواجهة برمجة التطبيقات وإدارتها، ومكان العثور على الحقول والوظائف والأذونات والملاحظات ومعلومات سجل التغيير المدعومة.
تسمح واجهة برمجة التطبيقات العامة ManageBac+ للمدارس بربط حساب ManageBac+ الخاص بها بمنصات خارجية غير مدمجة مباشرة مع ManageBac+ .
يمكن فقط لمسؤول حساب مدرستك تكوين هذه الإعدادات. يغطي هذا الدليل الإعداد وإدارة الرموز المميزة والوظائف المدعومة والملاحظات الفنية والأذونات والأسئلة الشائعة.
ملخص
تم تصميم ManageBac+ public API للمدارس التي تحتاج إلى بناء اتصالات مخصصة مع أنظمة الطرف الثالث. يتم التحكم في الوصول إلى واجهة برمجة التطبيقات (API) من خلال الرموز المميزة التي يتم إنشاؤها وإدارتها بواسطة المسؤولين.
من خلال مدير واجهة برمجة التطبيقات (API Manager)، يمكنك إنشاء الرموز المميزة، والتحكم في الأذونات، ومراجعة حالة الرمز المميز، والوصول إلى الوثائق المرجعية، وعرض سجل تغييرات واجهة برمجة التطبيقات (API).
الإعدادات > التطوير لديه الآن مديران لواجهة برمجة التطبيقات. يقوم API Manager (Legacy) بإنشاء رموز واجهة برمجة التطبيقات الموضحة في هذا الدليل. يُصدر API Manager (OAuth2) بيانات اعتماد OAuth2. استخدم النظام الذي يدعمه النظام الذي تتصل به.
المفاهيم الأساسية / ما هو الجديد
المجالات والوظائف المدعومة
افتح علامة التبويب "المستندات المرجعية" من القائمة اليمنى للحصول على إرشادات مفصلة حول إعداد اتصالات واجهة برمجة التطبيقات، بما في ذلك الملاحظات التي تحتوي على نماذج الطلبات والاستجابات. تتضمن هذه الصفحة أيضًا قائمة منسدلة للإصدار في الأعلى حتى تتمكن من استخدام الطلبات المتاحة المدرجة لإصدارات API المختلفة.
أذونات واجهة برمجة التطبيقات
بالنسبة لحقول الأذونات، يمكنك اختيار لا شيء أو تحديد الحقول التي تتمتع بحقوق القراءة فقط أو تحديد الكل. يمكنك أيضًا تحديد الحقول الفردية عن طريق تحديد خانة الاختيار.
طلاب
- فِهرِس
- يعرض
- يخلق
- تحديث
- أرشيف
- غير أرشفة
آباء
- فِهرِس
- يعرض
- يخلق
- تحديث
- أرشيف
- غير أرشفة
المعلمين
- فِهرِس
- يعرض
- يخلق
- تحديث
مجموعات السنة
- فِهرِس
- المستشارين
- طلاب
- إضافة الطلاب
- إزالة الطلاب
- فترة الحضور
- تاريخ الحضور
فصول
- فِهرِس
- يعرض
- طلاب
- إضافة الطلاب
- إزالة الطلاب
- فترة الحضور
- تاريخ الحضور
التقييمات الصفية
- الدرجات-الدرجات
العضويات
- فِهرِس
مدرسة
- يعرض
- السنوات الأكاديمية
- المواضيع
- الدرجات
المهام
- com.indexshowstudents
وظائف واجهة برمجة التطبيقات
مجموعات السنة
- احصل على جميع مجموعات السنة
- احصل على المستشارين
- الحصول على الطلاب لمجموعة السنة
- إضافة الطلاب إلى مجموعة السنة
- إزالة الطلاب من مجموعة السنة
- احصل على حضور الصف لمدة عام كامل وفصل دراسي
- احصل على حضور Homeroom لمجموعة سنوية في تاريخ محدد
فصول
- الحصول على جميع الفصول
- احصل على فصل دراسي
- الحصول على الطلاب لفئة
- إضافة الطلاب إلى الفصل الدراسي
- إزالة الطلاب من الفصل الدراسي
- الحصول على المهام لفئة
- الحصول على مهمة لفئة
- احصل على نتائج تقييم الطلاب لمهمة وفصل دراسي
- احصل على درجات الفصل الدراسي
- احصل على جميع الدرجات للفصل الدراسي خلال الفصل الدراسي
- الحصول على الحضور لفصل دراسي خلال الفصل الدراسي
- احصل على حضور الفصل في موعد
العضويات
- الحصول على كافة العضويات
طلاب
- الحصول على جميع الطلاب
- احصل على طالب
- إنشاء طالب جديد
- تحديث الطالب
- أرشفة الطالب
- إلغاء أرشفة الطالب
المعلمين
- الحصول على جميع المعلمين
- احصل على مدرس
- إنشاء معلم جديد
- تحديث المعلم
آباء
- الحصول على جميع الآباء
- احصل على أحد الوالدين
- إنشاء والد جديد
- تحديث أحد الوالدين
- أرشفة أحد الوالدين
- إلغاء أرشفة أحد الوالدين
مدرسة
- الحصول على تفاصيل المدرسة
- الحصول على السنوات الأكاديمية
- الحصول على الدرجات المدرسية
- الحصول على المواد الدراسية
المرافق
- بينغ
- احصل على الصورة الرمزية
سجل تغيير واجهة برمجة التطبيقات
يمكنك عرض سجل تغييرات واجهة برمجة التطبيقات في ManageBac+ بالانتقال إلى الإعدادات > تطوير > API Manager (Legacy). في أسفل هذه الصفحة، ستجد قسم سجل التغيير ، حيث يتم إدراج تحديثات واجهة برمجة التطبيقات الأخيرة بترتيب زمني، بما في ذلك الحقول الجديدة ونقاط النهاية المضافة أو المعدلة والتغييرات الفنية الأخرى ذات الصلة.
التنقل خطوة بخطوة
قم بتمكين ManageBac+ public API وأضف رمزًا مميزًا
- انتقل إلى الإعدادات > التطوير > API Manager (Legacy) > إضافة رمز مميز جديد.
- انقر فوق إضافة رمز مميز جديد.
- أدخل اسمًا واضحًا ومفيدًا للرمز المميز حتى يكون من السهل تحديد الغرض من استخدام الرمز المميز.
- حدد النقاط التي تريد تحديثها واسترجاعها، بما في ذلك بيانات الطالب وأولياء الأمور والمعلمين ومجموعات البكالوريا الدولية والفصول الدراسية وإعدادات المدرسة.
- انقر فوق إضافة رمز مميز لإنشاء الرمز المميز.
تحرير أو إدارة رمز API المميز
- افتح الإعدادات > التطوير > API Manager (Legacy).
- استخدم رمز الحافظة لنسخ الرمز المميز لاستخدامه في نظام آخر موثوق به.
- قم بالتمرير فوق أيقونة i لعرض أذونات الرمز المميز.
- قم بمراجعة حالة الرمز المميز لمعرفة ما إذا كان ممكّنًا أم معطلاً.
- انقر فوق "تحرير" لضبط الأذونات أو تعطيل الرمز المميز أو تمكينه.
- احذف الرمز المميز باستخدام أيقونة سلة المهملات عندما لا تكون هناك حاجة للتكامل.
تحذيرات وملاحظات هامة
تحذير أمني
يجب مشاركة رمز واجهة برمجة التطبيقات (API) الخاص بك فقط مع الأطراف الموثوقة. لا ينبغي أبدًا إرسال الرموز المميزة لواجهة برمجة التطبيقات (API) عبر البريد الإلكتروني أو حفظها في النماذج دون تشفير SSL. بمجرد عدم استخدام التكامل، نوصي بتعطيل رمز واجهة برمجة التطبيقات (API) من خلال النقر على أيقونة الحذف.
ملاحظات واجهة برمجة التطبيقات
- لا يتم عرض القيم الخالية أبدًا.
- يتم تجاهل القيم الخالية في طلبات POST.
- لا يتم تجاهل قيم السلسلة الفارغة وسيتم استبدال القيم الموجودة.
- ستُرجع أي مكالمة خطأً عندما لا تتمكن من العثور على مستخدم للتخصيص الجماعي، على سبيل المثال parent_ids أو child_ids.
- المعلمات المتاحة لمكدس إجراءات الفهرس باستخدام المنطق AND. قد لا يؤدي استخدام Adjust_since و delete_since في نفس الوقت إلى إرجاع النتيجة المتوقعة لأن الحذف لا يغير الطابع الزمني لتعديل السجل.
- يمكن لأي مستخدمين لديهم دور المسؤول القراءة فقط من خلال واجهة برمجة التطبيقات لأسباب أمنية.
- تكون جميع حقول الطابع الزمني بتنسيق ISO8601، على سبيل المثال yyyy-mm-ddThh:mm:ss.sssTZ مثل 2017-11-06T04:35:00.000GST.
- إذا كانت لديك أسئلة أو استفسارات بشأن واجهة برمجة التطبيقات (API)، فيرجى الاتصال بـ api@managebac.com.
حد المعدل
حد طلب واجهة برمجة التطبيقات (API) هو 200 طلب في الدقيقة من نفس عنوان IP.
الأسئلة المتداولة
هل يتكامل ManageBac+ مع منصة أخرى؟
إذا لم يكن المنتج مدرجًا ضمن الإعدادات > عمليات التكامل > الشركاء ، فلن تكون هناك علاقة رسمية. في هذه الحالات، قد تظل مدرستك قادرة على إنشاء تكامل مخصص باستخدام واجهة برمجة التطبيقات العامة.
هل يمكن ManageBac+ Support بناء تكامل لمدرستنا؟
أخبرنا بالنظام الذي ترغب في دمجه مع ManageBac+ ، وسننظر فيما إذا كان من المنطقي بالنسبة لنا كشركة ومنتج أن نصبح شريكًا مباشرًا مع تلك الأداة أو الخدمة.
هل يستطيع فريق دعم ManageBac+ كتابة طلب واجهة برمجة التطبيقات لنا؟
يمكن لفريق دعم ManageBac+ تقديم إرشادات بشأن الأسئلة والمشكلات المتعلقة بواجهة برمجة التطبيقات (API)، ولكن يجب إكمال جميع طلبات واجهة برمجة التطبيقات مباشرةً بواسطة مدرستك. إذا كنت تقوم بإنشاء اتصال مخصص، فيرجى استشارة قسم تكنولوجيا المعلومات لديك.
ما هو الحد الأقصى لمعدل ManageBac+ API؟
حد طلب واجهة برمجة التطبيقات (API) هو 200 طلب في الدقيقة من نفس عنوان IP.
أين يمكنني العثور على إرشادات حول كيفية استخدام ManageBac+ API العامة؟
يرجى الرجوع إلى الإعدادات > التطوير > المستندات المرجعية للحصول على تفاصيل حول كل حقل وأحدث ملاحظات سجل التغيير.
طلب API الخاص بي به مشكلة. بمن يجب أن أتصل؟
يرجى إرسال بريد إلكتروني إلى api@managebac.com يتضمن تفاصيل واضحة عن الطلب والخطأ الذي تواجهه.
في ملخص
- تسمح واجهة برمجة التطبيقات العامة ManageBac+ للمدارس بربط ManageBac+ بالأنظمة الخارجية من خلال الرموز المميزة التي يديرها المسؤول.
- يمكنك إنشاء الرموز المميزة ومراجعتها وتحريرها وتعطيلها وحذفها من الإعدادات > تطوير > API Manager (Legacy).
- تتوفر المستندات المرجعية والأذونات وملاحظات واجهة برمجة التطبيقات وتفاصيل سجل التغيير وإرشادات الدعم الشائعة ضمن سير عمل مدير واجهة برمجة التطبيقات.
يمنح ManageBac+ المدارس طريقة يمكن التحكم فيها لإنشاء عمليات تكامل مخصصة مع الحفاظ على أمان الوصول إلى واجهة برمجة التطبيقات (API) واستنادًا إلى الأذونات.