إعداد تكامل REST API مع مفتاح المطورين لـ Canvas
مفتاح المطور لـ Canvas هو بديل قوي لنهج الرمز المميز للوصول، حيث يمكن تمكين أي نقطة نهاية (نطاق) لـ Canvas REST أو تعطيلها من أجل عمليات التكامل.
لإعداد تكامل REST API، عليك إنجاز الخطوات التالية
إنشاء مفتاح مطور API في بيئة Canvas الخاصة بك
تكوين Ally باستخدام مفتاح مطور Canvas
إنشاء مفتاح مطور واجهة برمجة التطبيقات
مفتاح API للمطورين في Canvas هو في الأساس مفتاح ID وزوج كلمات سر ممزوج مع تكوين نطاق محدد.
انتقل إلى الحساب الجذر لمثيل Canvas وانتقل إلى "Developer keys" (مفاتيح المطورين).
حدد زر "+ Developer Key" (+ مفتاح مطور) وحدد "API Key" (مفتاح API).
قم بتقديم اسم المفتاح وعنوان البريد الإلكتروني للمالك.
انسخ هذا الرابط والصقه في الحقل "Redirect URIs" (إعادة توجيه عناوين URL). استبدل
[AllyEnvironment]بمعلومات البيئة التي تتم استضافة المؤسسة فيها. استبدل "[ClientID]" بمعرف العميل الخاص بك.https://[AllyEnvironment]/api/v2/[ClientId]/auth/canvas/callbackحدد مفتاح التبديل "Enforce Scopes" (فرض النطاقات) لتشغيلها.
حدد خانة الاختيار "Allow Include Parameters" (السماح بتضمين المعلمات).
قم بتمكين النطاقات التالية من الجدول:
جدول 7. تمكين هذه النطاقاتاسم النطاق
القسم
url:GET|/api/v1/accountsالحسابات
url:GET|/api/v1/accounts/:idالحسابات
url:GET|/api/v1/accounts/:account_id/sub_accountsالحسابات
url:GET|/api/v1/accounts/:account_id/coursesالحسابات
url:GET|/api/v1/courses/:course_id/assignmentsتخصيص
url:GET|/api/v1/courses/:course_id/assignments/:idتخصيص
url:PUT|/api/v1/courses/:course_id/assignments/:idتخصيص
url:GET|/api/v1/courses/:course_id/blueprint_subscriptionsالمقررات الدراسية في المخطط
url:GET|/api/v1/courses/:course_id/blueprint_subscriptions/:subscription_id/migrationsالمقررات الدراسية في المخطط
url:GET|/api/v1/courses/:course_id/content_migrationsترحيلات المحتوى
url:GET|/api/v1/courses/:idالمقررات الدراسية
url:PUT|/api/v1/courses/:idالمقررات الدراسية
url:POST|/api/v1/courses/:course_id/filesالمقررات الدراسية
url:GET|/api/v1/courses/:course_id/discussion_topicsموضوعات المناقشة
url:GET|/api/v1/courses/:course_id/discussion_topics/:topic_idموضوعات المناقشة
url:PUT|/api/v1/courses/:course_id/discussion_topics/:topic_idموضوعات المناقشة
url:GET|/api/v1/accounts/:account_id/termsمدد التسجيل
url:GET|/api/v1/courses/:course_id/filesالملفات
url:GET|/api/v1/courses/:course_id/files/:idالملفات
url:PUT|/api/v1/files/:idالملفات
url:DELETE|/api/v1/files/:idالملفات
url:GET|/api/v1/courses/:course_id/media_objectsكائنات الوسائط
url:PUT|/api/v1/media_objects/:media_object_idكائنات الوسائط
url:GET|/api/v1/media_objects/:media_object_id/media_tracksكائنات الوسائط
url:PUT|/api/v1/media_objects/:media_object_id/media_tracksكائنات الوسائط
url:GET|/api/v1/courses/:course_id/pagesالصفحات
url:GET|/api/v1/courses/:course_id/pages/:url_or_idالصفحات
url:PUT|/api/v1/courses/:course_id/pages/:url_or_idالصفحات
url:GET|/api/v1/courses/:course_id/quizzesالاختبارات الموجزة
url:GET|/api/v1/courses/:course_id/quizzes/:idالاختبارات الموجزة
url:PUT|/api/v1/courses/:course_id/quizzes/:idالاختبارات الموجزة
حدد حفظ.
تتم إضافة المفتاح الجديد إلى صفحة "Developer Keys" (مفاتيح المطورين) ويكون في وضع "OFF" (إيقاف التشغيل) بشكل افتراضي.
قم بتشغيل المفتاح الجديد.
انسخ رقم معرف المفتاح في عمود التفاصيل.
بيئة Ally لمنطقتك
استخدم المعلومات الخاصة ببيئة Ally التي تستضيف مؤسستك.
مركز بيانات الولايات المتحدة:
prod.ally.acمركز البيانات الكندي:
prod-ca-central-1.ally.acمركز البيانات الأوروبي:
prod-eu-central-1.ally.acمركز بيانات سنغافورة:
prod-ap-southeast-1.ally.acمركز البيانات الأسترالي:
prod-ap-southeast-2.ally.ac
تكوين Ally باستخدام مفتاح المطور
يجب تسجيل الدخول إلى كل من بيئة Canvas وصفحة تكوين Ally.
انتقل إلى صفحة تكوين Ally وحدد علامة التبويب "Canvas Developer Key" (مفتاح المطور لـ Canvas).
حدد "Configure Ally with Canvas Developer Key" (تكوين Ally باستخدام مفتاح مطور Canvas).
انسخ والصق المفتاح والسر الخاص بمفتاح مطور API الذي أنشأته.
حدد "Save and grant access" (حفظ ومنح إمكانية الوصول).
حدد تخويل لمنح Ally الإذن لاستخدام مفتاح مطور اللوحة.
في الخلفية، ستشغل Ally فحصًا سريعًا (بسيطًا) لضمان إضافة النطاقات الصحيحة في مفتاح المطور لـ Canvas.
وإذا كانت الأمور تسير بشكل جيد، فلا بد أن يتم توجيهك مرة أخرى إلى أداة التكوين مع ظهور رسالة تقول إنه قد تم تكوين التكامل بشكل صحيح.