واجهة برمجة التطبيقات العامة لـ OpenApply وتوسيع الوظائف

تقدم مجموعة Faria التعليمية الدعم لواجهة برمجة التطبيقات العامة (Public API) مباشرةً من خلال إعدادات حساب OpenApply الخاص بك ضمن: الإعدادات > التطوير > واجهة برمجة التطبيقات العامة (Public API) أو وثائق واجهة برمجة التطبيقات (API).

بالإضافة إلى مجموعة كاملة من واجهات برمجة التطبيقات العامة، نقدم أيضًا مقالات دعم توضح كيفية استخدامها لتحقيق المهام المطلوبة بشكل متكرر.

فيما يلي بعض الأمثلة على التعليمات.

استكشاف واجهات برمجة تطبيقات مجموعة Faria التعليمية: بوابة التكامل

تُقدّم مجموعة Faria التعليمية واجهات برمجة تطبيقات (APIs) قوية لبرامج OpenApply و ManageBac و SchoolsBuddy ، لدعم مجموعة واسعة من احتياجات التكامل والأتمتة. وتوصي Faria الآن بالبدء ببوابة التكاملات لتجربة سلسة عبر المتصفح، بما في ذلك اختبار نقاط النهاية المباشر باستخدام بيانات اعتمادك الخاصة.

بوابة التكامل: النهج الموصى به

تم تصميم بوابة التكاملات لاستكشاف واجهة برمجة التطبيقات التفاعلية والاختبار المباشر، مباشرة في متصفحك.

الفوائد الرئيسية:

• لا حاجة لتثبيت أي برامج: كل شيء يعمل في متصفحك.
• زر "اختبره" المباشر: جرب نقاط نهاية واجهة برمجة التطبيقات على الفور وشاهد الاستجابات الحقيقية.
• إدارة بيانات الاعتماد الآمنة: المصادقة باستخدام مفاتيح API الخاصة بك أو بيانات اعتماد OAuth.
• ردود فعل فورية: استكشاف الأخطاء وإصلاحها وفهم سلوك واجهة برمجة التطبيقات في الوقت الفعلي.

كيفية البدء:

1. قم بزيارة بوابة التكاملات.
2. اختر منتجك ( OpenApply ، ManageBac ، SchoolsBuddy ).
3. تصفح وثائق واجهة برمجة التطبيقات (API) واختر نقطة نهاية.
4. انقر على زر "اختبره".
5. أدخل بيانات اعتماد المصادقة الخاصة بك (انظر أدناه للإعداد).
6. قم بتعبئة البيانات المطلوبة وأرسل الطلب.
7. يمكنك الاطلاع على الرد المباشر مباشرةً في البوابة.

إعداد المصادقة:

• OpenApply v3:
  • انتقل إلى OpenApply > التكاملات > واجهة برمجة التطبيقات العامة.
  • قم بتمكين واجهة برمجة التطبيقات العامة وأضف تطبيق OAuth جديدًا لإنشاء معرف العميل والسر الخاص بك.
  • بعد تحديد "إضافة تطبيق" و "حفظ التغييرات" ، سيتم عرض معرف العميل وسر العميل.
  • إذا طلب التكامل اسم المضيف ، فأدخل عنوان OpenApply الخاص بمدرستك، على سبيل المثال yourschool.openapply.com.
  • دليل مصادقة واجهة برمجة تطبيقات OpenApply v3
• ManageBac+ الإصدار 2:
  • انتقل إلى ManageBac > الإعدادات > التكاملات > الوصول إلى واجهة برمجة التطبيقات.
  • قم بإنشاء أو استرداد مفتاح API الخاص بك.
  • دليل مصادقة واجهة برمجة تطبيقات ManageBac+ الإصدار 2
• SchoolsBuddy :
  • انتقل إلى SchoolsBuddy > الإعدادات > مدير واجهة برمجة التطبيقات > انقر فوق "إضافة"
  • قم بإنشاء معرف العميل والسر الخاص بك

  • دليل مصادقة واجهة برمجة تطبيقات SchoolsBuddy

حدود المعدل

تسمح واجهة برمجة OpenApply بطلب واحد كل ثلاث ثوانٍ. إذا أرسلت طلبات أسرع من ذلك، ستُعيد واجهة برمجة التطبيقات خطأ HTTP 429. أضف فترة انتظار أو مُحدد معدل إلى عملية التكامل الخاصة بك لضمان بقائها ضمن الحد المسموح به. يحتوي بوابة التكاملات على أدلة حول تحديد معدل الطلبات والترقيم.

للاطلاع على الحقول التي يمكن لواجهة برمجة التطبيقات تحديثها، ورموز حالة الاستجابة، ومرجع نقطة النهاية الحالية، استخدم قسم OpenApply في بوابة التكاملات. لتحديث حقول الطلاب الأخرى دفعة واحدة، استخدم استيراد ملف Excel أو CSV.

تصفية نقطة نهاية الطلاب

• تقوم الدالة since_date بإرجاع بيانات الطلاب الذين تم تحديث بياناتهم منذ تاريخ معين.
• تقوم since_id بإرجاع الطلاب الذين لديهم معرف أعلى من المعرف الذي قمت بإدخاله.
• تُستخدم فلاتر status حسب حالة الطالب، باستخدام تصنيف الحالة أو رمزها الرقمي. تحتاج إلى هذه المعلمة لعرض الطلاب المتخرجين أو المنسحبين.

كيفية استرداد الملفات المرتبطة بالطلاب من OpenApply عبر واجهة برمجة التطبيقات (API).

المشكلة: يُستخدم OpenApply كنقطة دخول في عملية القبول، حيث يقوم أولياء الأمور بتحميل صور جوازات السفر وغيرها من البيانات. ترغبون في تخزين هذه البيانات في نظام آخر، أو ربما تحميلها إلى نظام معلومات الطلاب (SIS) أو نظام إدارة المعلومات (MIS) الخاص بمدرستكم.

الحل: يحتوي OpenApply على ميزة تصدير تسمح لك بتصدير جميع الملفات دفعة واحدة، ولكن إذا كنت تبحث عن عملية آلية، فيمكنك استخدام واجهات برمجة التطبيقات (APIs) لتحقيق ذلك.

ملحوظات:

• تم تفعيل الوصول إلى واجهة برمجة التطبيقات (API) في OpenApply (يلزم الحصول على صلاحيات المسؤول)
• تم إنشاء معرّف العميل وسر OAuth 2.0 في OpenApply :
• الإلمام بطلبات واجهة برمجة التطبيقات (API) والمصادقة

دليل مصادقة واجهة برمجة التطبيقات

الخطوات المتبعة:

1. ندعم استخدام واجهة برمجة التطبيقات (API) للحصول على جميع معلومات الطلاب، بما في ذلك إمكانية تصفيتها، واسترجاع التحديثات منذ آخر اتصال. تتضمن هذه المعلومات رابطًا سريًا لملفات PDF المُقدمة مع نموذج الطلب.
2. يمكنك بعد ذلك تنزيل هذه الأصول بشكل آمن، وحفظها على القرص، أو تحميلها إلى المنصة المستهدفة.

استرجاع ملفات الطلاب عبر واجهة برمجة التطبيقات (API)
لتصدير ملفات طالب معين:

 GET /api/v3/students/{id}/files

• استبدل {id} بمعرف قاعدة بيانات OpenApply الخاص بالطالب.
• استخدم المعامل since_date لجلب الملفات التي تم تحديثها فقط منذ آخر عملية تصدير.

مثال:

 curl -X GET "https://api.openapply.com/api/v3/students/12345/files?since_date=2026-01-01" \
-H "التفويض: حامل رمز الوصول الخاص بك"

يتضمن الرد بيانات وصفية وعناوين URL آمنة لكل ملف، والتي يمكنك تنزيلها ومعالجتها حسب الحاجة.

مرجع واجهة برمجة التطبيقات – الملفات

أتمتة وجدولة عمليات التصدير

• استخدم المعامل since_date لجلب الملفات الجديدة أو المحدثة فقط.
• قم بجدولة عملية التكامل لتشغيلها على فترات منتظمة (مثلاً، ليلاً) للحفاظ على تحديث النظام المستهدف.
• قم بتخزين بيانات اعتماد واجهة برمجة التطبيقات (API) بشكل آمن وقم بتدويرها حسب الحاجة.

أفضل الممارسات الأمنية

كيفية تنزيل الحقول المخصصة والبحث باستخدامها

المشكلة: باستخدام OpenApply ، يمكن للمدارس إنشاء عدد غير محدود من الحقول المخصصة التي يمكن ملؤها ببيانات قيّمة. وبينما يدعم OpenApply أيضًا ميزات تصدير واسعة النطاق، فكيف يمكن استخدام واجهة برمجة التطبيقات (API) لإدارة تدفقات البيانات لدينا بهدف أتمتة العمليات؟

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