مفتاح المطور لـ Canvas هو بديل قوي لنهج الرمز المميز للوصول، حيث يمكن تمكين أي نقطة نهاية (نطاق) لـ Canvas REST أو تعطيلها من أجل عمليات التكامل.

لإعداد تكامل REST API، عليك إنجاز الخطوات التالية

  1. إنشاء مفتاح مطور API في بيئة Canvas الخاصة بك
  2. تكوين Ally باستخدام مفتاح مطور Canvas

إنشاء مفتاح مطور API

مفتاح API للمطورين في Canvas هو في الأساس مفتاح ID وزوج كلمات سر ممزوج مع تكوين نطاق محدد.

  1. انتقل إلى الحساب الجذر لمثيل Canvas وانتقل إلى "Developer keys" (مفاتيح المطورين).
  2. حدد زر "+ Developer Key" (+ مفتاح مطور) وحدد "API Key" (مفتاح API).
  3. قم بتقديم اسم المفتاح وعنوان البريد الإلكتروني للمالك.
  4. انسخ هذا الرابط والصقه في الحقل "Redirect URIs" (إعادة توجيه عناوين URL). استبدل [AllyEnvironment] بـمعلومات البيئة التي تستضيف مؤسستك. استبدل [ClientID] بمعرف العميل الخاص بك.

    https://[AllyEnvironment]/api/v2/[ClientId]/auth/canvas/callback

  5. حدد مفتاح التبديل "Enforce Scopes" (فرض النطاقات) لتشغيلها.
  6. حدد خانة الاختيار "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/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 الاختبارات الموجزة
  8. حدد "Save" (حفظ).
  9. تتم إضافة المفتاح الجديد إلى صفحة "Developer Keys" (مفاتيح المطورين) ويكون في وضع "OFF" (إيقاف التشغيل) بشكل افتراضي.
  10. قم بتشغيل المفتاح الجديد.
  11. انسخ رقم معرف المفتاح في عمود "Details" (التفاصيل)

بيئة 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 Configuration" (تكوين Ally) لديك.

  1. انتقل إلى صفحة تكوين Ally وحدد علامة التبويب "Canvas Developer Key" (مفتاح المطور لـ Canvas).
  2. حدد "Configure Ally with Canvas Developer Key" (تكوين Ally باستخدام مفتاح مطور Canvas).
  3. انسخ والصق المفتاح وكلمة السر الخاصين بمفتاح مطور API الذي أنشأته.
  4. حدد "Save and grant access" (حفظ ومنح إمكانية الوصول).
  5. حدد "Authorize" (تخويل) لمنح Ally الإذن لاستخدام مفتاح المطور لـ Canvas.

في الخلفية، ستشغل Ally فحصًا سريعًا (بسيطًا) لضمان إضافة النطاقات الصحيحة في مفتاح المطور لـ Canvas.

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