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