اربطوا برامجكم الأخرى بسكوليوم سكولاريتي، للقراءة فقط
يمكن لبرنامج المحاسبة أو أداة الإحصائيات أو لوحة القيادة أن يقرأ تلاميذ المؤسسة وأقسامها ومستوياتها ومستحقاتها وأداءاتها وغيابها عبر واجهة برمجة REST (JSON عبر HTTPS)، دون أن يستطيع تغيير أي شيء. تبقى الواجهة مغلقة ما لم تُنشئ إدارتكم مفتاحاً.
ست قواعد تلتزم بها الواجهة
قراءة فقط، من حيث التصميم
لا تستجيب الواجهة إلا لطلبات GET (وHEAD): لا يمكنها إنشاء أي شيء أو تعديله أو حذفه في المنصة، وتُرفض أي طريقة أخرى. تُعدَّل البيانات دائماً داخل سكوليوم سكولاريتي، من طرف المستخدمين المرخَّص لهم.
سبعة موارد
المؤسسة، والمستويات، والأقسام، والتلاميذ، والمستحقات، والأداءات، والغياب (بما فيه التأخرات). القوائم مقسَّمة إلى صفحات، حتى 200 عنصر في الصفحة، ويمكن مزامنة التلاميذ تدريجياً ابتداءً من تاريخ معيَّن.
مفتاح لكل برنامج، بقرار من المؤسسة
تُنشئ الإدارة مفتاحاً من الإعدادات › واجهة API باسم البرنامج الذي تربطه، وخمسة مفاتيح نشطة على الأكثر لكل مؤسسة. لا يُعرض المفتاح إلا مرة واحدة، ولا تحتفظ سكوليوم إلا ببصمته. ويمكن إلغاء كل مفتاح في أي وقت دون المساس بالمفاتيح الأخرى.
مغلقة افتراضياً، ومعزولة لكل مؤسسة
بدون مفتاح، لا تُجيب الواجهة بشيء. ولا يرى المفتاح إلا مؤسسته. الاتصال عبر HTTPS فقط، ويُرسَل المفتاح في ترويسة الطلب (Authorization: Bearer أو X-Api-Key)، ولا يوضع أبداً في العنوان.
سقف واضح، وسجلّ لكل طلب
60 طلباً في الدقيقة لكل مفتاح. يُسجَّل كل طلب (التاريخ، والمورد، وعدد العناصر، وعنوان IP) ويُحتفظ به 90 يوماً، وترى الإدارة لكل مفتاح آخر استعمال له وعدد طلباته.
البيانات الضرورية فقط
وفقاً لمبدأ تقليص البيانات في القانون المغربي 09-08 والنظام الأوروبي RGPD، لا تُرجع الواجهة العناوين ولا الصور ولا أماكن الازدياد ولا الملاحظات الداخلية ولا سبب الغياب أو مبرِّره ولا التعليقات الحرة على الأداءات ولا معلومات الاتصال بأولياء الأمور.
بوضوح: الإصدار 1 يقرأ ولا يكتب. قد تُضاف إليه حقول، لكن لن يُعاد تسمية أي حقل أو حذفه دون إصدار جديد يُعلَن عنه مسبقاً. وتبقى المؤسسة مسؤولة عن المعالجة: هي التي تقرر أي برنامج يحصل على مفتاح.
طلب واحد، ترويسة واحدة، وJSON في المقابل
يظهر عنوان الواجهة في الإعدادات › واجهة API. هكذا يبدو طلبٌ يعرض التلاميذ المسجَّلين:
curl -H "Authorization: Bearer sco_…" \
"https://app.scoliom.com/api/v1.php?resource=students&status=inscrit&per_page=100"school— المؤسسة صاحبة المفتاح وسنتها الدراسية الجاريةlevels— المستويات، مع مستوى الانتقال المواليclasses— أقسام السنة الدراسية، مع عدد التلاميذ المسجَّلين في كل قسمstudents— التلاميذ: الرقم، والرقم الوطني (رمز مسار في المغرب)، والأسماء بالحروف اللاتينية والعربية، والوضعية، والقسم والمستوىinstallments— المستحقات: المبلغ، والمبلغ المؤدى، والباقي، وتاريخ الاستحقاق، والوضعيةpayments— الأداءات المستخلَصة: المبلغ، والتاريخ، وطريقة الأداء، ورقم الوصل، ووضعية الشيكabsences— الغياب والتأخرات، مع وضعية التبرير
كل مورد وحقل ومعطى ورمز خطأ موصوف في التوثيق التقني، المتوفر بالفرنسية وبالإنجليزية. لا يتوفر حالياً توثيق باللغة العربية.
واجهة البرمجة: أسئلة الإدارات ومزوّديها
لا. الإصدار 1 للقراءة فقط: لا يستجيب إلا لطلبات GET وHEAD ويرفض أي طريقة أخرى. تُعدَّل البيانات داخل المنصة، من طرف المستخدمين المرخَّص لهم.
إدارة المؤسسة. تُنشئ مفتاحاً لكل برنامج من الإعدادات › واجهة API، بخمسة مفاتيح نشطة على الأكثر، ويمكنها إلغاء أي منها في أي وقت. بدون مفتاح، تبقى الواجهة مغلقة.
العناوين، والصور، وأماكن الازدياد، والملاحظات الداخلية، وسبب الغياب أو مبرِّره، والتعليقات الحرة على الأداءات، ومعلومات الاتصال بأولياء الأمور. تطبّق الواجهة مبدأ تقليص البيانات في القانون المغربي 09-08 والنظام الأوروبي RGPD.
نعم: 60 طلباً في الدقيقة لكل مفتاح. بعد ذلك، تطلب الواجهة من البرنامج الانتظار دقيقة قبل إعادة الطلب. وتُرجع القوائم حتى 200 عنصر في الصفحة.
على الإنترنت، بالفرنسية (app.scoliom.com/api.html) وبالإنجليزية (app.scoliom.com/api-en.html). يصف كل مورد وحقل ومعطى ورمز خطأ. لا يتوفر حالياً توثيق باللغة العربية.
أخبرونا بما تريدون ربطه
نجيب كتابياً عن الأسئلة التقنية: مورد، أو حقل، أو الطريقة المناسبة للمزامنة.
رد مكتوب · دون التزام