موتميت كيفية استخدام واجهة برمجة تطبيقات Motimate العامة؟
استخدم واجهة برمجة التطبيقات العامة لأتمتة تكامل المستخدم ومزامنته مع مصدر بياناتك، وربط Motimate بخدمات رائعة أخرى 🔀
واجهة برمجة التطبيقات العامة v2 متاحة الآن لجميع العملاء!
- وثائق PAPI v1 (قديم فقط - سيحصل جميع العملاء الجدد على الإصدار 2)
- وثائق PAPI v2
واجهة برمجة التطبيقات العامة هي مجموعة من الخدمات التي يمكن استخدامها لتحديث البيانات وإدارتها في Motimate. وهي موثقة بطريقة قياسية، تسمى OpenAPI، وتوفر للمطورين وصولاً برمجياً إلى برنامجنا كخدمة. تحتوي واجهة برمجة التطبيقات هذه على دعم أوسع مما يمكنك القيام به مع SCIM و CSV، ولكنك تحتاج إلى خدمة تكامل أو روبوت برمجي لاستخدامها.
إن إطلاق PAPI v2 يجعل تصدير البيانات من MotiSpace أسهل من أي وقت مضى مع نقاط نهاية مثل:
يرجى الملاحظة:
- تحتاج إلى طلب بيانات اعتماد واجهة برمجة التطبيقات (API) من الدعم لبدء استخدام هذه الخدمة.
- يتم تحديث قاعدة بيانات API على فترات منتظمة عدة مرات كل ساعة.
نماذج البيانات
توفر واجهة برمجة التطبيقات العامة نماذج لأتمتة توفير المستخدم ومشاركات النبض. يحتوي على نماذج البيانات هذه
-
نموذج المستخدم: يمكنك استخدام هذا لقراءة وكتابة وتحديث المعلومات الخاصة بحسابات المستخدمين. يمكن أن يتضمن ذلك معلومات الاتصال، وأدوار الوصول، وتعيينات المجموعات لإدارة المحرك. إذا كان لدى المستخدم وظيفة واحدة أو عدة وظائف، فيمكن تعيين ذلك أيضًا في نقطة النهاية هذه.
-
نموذج المجموعات: يسمح لك هذا بقراءة مجموعات المستخدمين وكتابتها وتعيينها. يمكن أيضًا تنظيم هذه المجموعات في هيكل شجري لتتناسب مع مؤسستك وتبسيط مهام التعلم.
هام: يتم تعريف مستوى المجموعة حاليًا باستخدام نوع السمة. يمكن أن تختلف قيمة النوعية من منظمة إلى أخرى. كما يمكن تغييره بسهولة من قبل مسؤول مؤسستك. عند إعداد تكامل واجهة برمجة التطبيقات، من المستحسن تحديد قائمة دائمة بأسماء الأنواع لمستويات مجموعتك لتجنب الخطأ المحتمل في تكامل واجهة برمجة التطبيقات في حالة تغير أسماء الأنواع.
-
نموذج المواضع: يسمح لك هذا النموذج بقراءة وكتابة المواقف التي يمكن تعيين حسابات المستخدمين إليها.
-
المنشورات: يمكنك استخدام هذا لإنشاء منشورات ونشرها على Pulse. يمكن القيام بذلك مع خدمات الملفات لتحميل الصور.
-
الملفات: تُستخدم هذه الخدمة لتحميل الصور لمنشورات النبض. يبلغ الحد الأقصى لحجم الصور 40 ميغابايت، ومقاطع الفيديو 100 ميغابايت، والمستندات 100 ميغابايت.
- الرؤى: تُستخدم هذه الخدمة لإنشاء رابط لتقرير مخصص والحصول عليه. يجب إنشاء قالب التقرير مسبقًا في منصة Motimate باستخدام ميزة "إنشاء التقارير" ضمن "الرؤى".
المصادقة
تُستخدم نقطة نهاية رمز OAuth Token لإنشاء رمز وصول مميز. احصل على معرف_العميل ورقم_العميل_الخاص بك عن طريق الاتصال بـ support@m otimateapp.com
بمجرد استلام هذه التفاصيل، يمكن إنشاء الرموز المميزة برمجياً أو عبر منصات مثل Postman. كل ما عليك القيام به هو إرسال مكالمة من واجهة برمجة التطبيقات إلى نقطة نهاية نقطة نهاية POST /oaST/oauth/tokensمع معرف_العميل وبيانات اعتماد_العميل_السرية التي تلقيتها من دعم Motimate كهيئة JSON.
ستستجيب واجهة برمجة التطبيقات برمز مميز فريد، والذي سيكون صالحاً لمدة 24 ساعة. يمكنك إنشاء أي عدد تريده من الرموز المميزة. يجب أن يتم تمرير الرمز المميز إلى رأس التخويل كرمز مرموز لحامله في طلباتك إلى جميع نقاط النهاية الأخرى ("حامل "+[رمزك المميز]).
مثال:"الحامل eyJhbkyFjHk0oIY6ghkkgkgRI1NiJ9.eyJ0b23Lo7G7G5Jk7mJkYzdiZD"
يمكنك استخدام نقطة النهاية نقطة نهاية GET /me للتحقق من رمز الوصول المميز. يكون هذا مفيدًا إذا كان لديك مخزن مفاتيح للاحتفاظ برمز الوصول الخاص بك وترغب في التحقق من أنه يعمل دون استدعاء أي استدعاءات للمعاملات.
كيفية اختبار واجهة برمجة التطبيقات (API):
لاختبار واجهة برمجة التطبيقات، نوصي باستخدام منصة واجهة برمجة تطبيقات مثل Postman. يمكنك العثور على دليل حول كيفية استيراد وثائق واجهة برمجة تطبيقات Motimate الكاملة إلى مجموعات Postman و Insomnia من هنا.
يجب عليك إنشاء الرمز المميز للوصول إلى واجهة برمجة التطبيقات كما هو موضح أعلاه، ثم إدخال هذا الرمز المميز كرمز لحامله في علامة تبويب التخويل داخل Postman. يمكنك بعد ذلك المضي قدمًا واختبار واجهة برمجة التطبيقات ومراجعة الردود.
لا توجد تعليقات
الرجاء تسجيل الدخول لترك تعليق.