إعداد واجهة برمجة تطبيقات SchoolsBuddy العامة
الآن بعد تفعيل الوصول إلى واجهة برمجة التطبيقات (API)، اتبع هذه الخطوات لإنشاء بيانات الاعتماد وإدارة عمليات التكامل الخاصة بك داخل بوابة SchoolsBuddy .
يشرح هذا الدليل كيفية إعداد وإدارة الوصول إلى واجهة برمجة التطبيقات (API) في SchoolsBuddy . تُمكّن هذه العملية فريقك التقني من المصادقة عبر OAuth 2.0 والبدء في ربط أنظمتك الخارجية بـ SchoolsBuddy .
يتطلب الوصول إلى هذه الإعدادات أذونات محددة؛ تأكد من تسجيل دخولك كمسؤول رئيسي للمؤسسة قبل المتابعة.
ملخص
تتوفر منطقة إدارة واجهة برمجة التطبيقات العامة لمسؤولي المؤسسة لإدارتها. هذه المنصة المركزية هي المكان الذي يمكنك من خلاله إنشاء وتعديل وتأمين العملاء المستخدمين في عمليات تكامل بيانات مدرستك.
المفاهيم الأساسية
قبل البدء في الإعداد، تأكد من استيفاء المتطلبات الأساسية التالية:
- أنت مسجل دخولك بصفتك مديرًا رئيسيًا للمنظمة .
- لديك وثائقك التقنية جاهزة لتكوين الأذونات والنطاقات اللازمة.
التنقل خطوة بخطوة
نصائح وأفضل الممارسات
- بيئة الاختبار: اختبر التكامل دائمًا في بيئة اختبار إذا كانت متاحة قبل الاتصال بنسخة SchoolsBuddy الحية الخاصة بك.
- عمليات الكتابة المجمعة: راجع الوثائق الفنية بدقة قبل بدء عمليات الكتابة المجمعة لضمان سلامة البيانات.
- صيانة بيانات الاعتماد: يمكنك من خلال مدير واجهة برمجة التطبيقات (API Manager) تعديل الأذونات، أو إعادة إنشاء بيانات الاعتماد، أو تعطيل/حذف العملاء للحفاظ على الأمان.
تحذيرات وملاحظات هامة
الوصول الأمني: توفر بيانات اعتماد واجهة برمجة التطبيقات (API) وصولاً واسع النطاق إلى بيانات مدرستك. تأكد من أن الموظفين المصرح لهم فقط هم من يملكون صلاحيات المدير العام لإدارة هذه الإعدادات.
المشاركة العامة: لا تشارك سر العميل الخاص بك علنًا أبدًا؛ فهذه البيانات مرتبطة بشكل فريد بمثيل SchoolsBuddy الخاص بك وتوفر وصولاً مباشرًا إلى نظام بياناتك.
مقالات ذات صلة
الأسئلة الشائعة
ماذا يحدث إذا فقدت سر العميل الخاص بي؟
لأسباب أمنية، لا يعرض SchoolsBuddy سر العميل مرة أخرى. ستحتاج إلى استخدام مدير واجهة برمجة التطبيقات (API Manager) لإعادة إنشاء بيانات الاعتماد لهذا العميل.
هل يمكنني تقييد ما يمكن أن تفعله واجهة برمجة التطبيقات (API)؟
نعم. أثناء عملية التكوين، يمكنك تحديد أذونات ونطاقات محددة لمنح الوصول اللازم للقراءة (GET) أو الكتابة (POST/PUT) فقط، وهو الوصول المطلوب لهذا التكامل المحدد.
في ملخص
- يمكنك الوصول إلى مدير واجهة برمجة التطبيقات (API Manager) عبر إعدادات مدير واجهة برمجة التطبيقات (API Manager ).
- قم بإنشاء بيانات اعتماد عن طريق إنشاء عميل جديد بنطاقات محددة.
- قم بتخزين معرفات العملاء وأسرارهم بشكل آمن ولا تشاركها علنًا أبدًا.
أصبح تكامل SchoolsBuddy الخاص بك جاهزًا الآن لبدء مزامنة البيانات.
يرتبط بـ