מפתח פיתוח של Canvas הוא חלופה מוצלחת לשיטת אסימון הגישה מאחר שכל נקודת קצה של REST ב-Canvas (טווח) ניתנת להפעלה או להשבתה עבור שילובים.
כדי להגדיר את השילוב הדרוש של REST API, יש לבצע את הפעולות הבאות
- צור מפתח פיתוח של API בסביבת Canvas שלך
- קבע את התצורה של Ally עם מפתח הפיתוח של Canvas
צור מפתח פיתוח של API
מפתח פיתוח של API ב-Canvas הוא למעשה זוג של מזהה מפתח וסוד המשולב עם תצורת טווח ספציפית.
- עבור לחשבון הבסיס של מופע Canvas ועבור אל מפתחות פיתוח.
- בחר את הלחצן + מפתח פיתוח ובחר מפתח API.
- ספק שם מפתח ודוא"ל של בעלים.
- העתק קישור זה והדבק אותו בשדה מזהי ה-URI לניתוב מחדש. החלף את [AllyEnvironment] בפרטי הסביבה שבה מוסד הלימודים שלך מתארח. החלף את [ClientID] במזהה הלקוח שלך.
https://[AllyEnvironment]/api/v2/[ClientId]/auth/canvas/callback
- בחר את הלחצן הדו-מצבי אכוף טווחים כדי להפעיל אותו.
- סמן את תיבת הסימון אפשר פרמטרי הכללה.
- הפעל טווחים אלה מהטבלה:
הפעל טווחים אלה שם טווח סעיף 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 קורסים של Blueprint url:GET|/api/v1/courses/:course_id/blueprint_subscriptions/:subscription_id/migrations קורסים של Blueprint 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 בחנים - בחר שמור.
- המפתח החדש מתווסף לדףמפתחות פיתוח והוא כבוי כברירת מחדל.
- הפעל את המפתח החדש.
- העתק את מספר מזהה המפתח בעמודה פרטים.
סביבת 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.
- בחר קבע את התצורה של Ally עם מפתח הפיתוח של Canvas.
- העתק והדבק את המפתח והסוד של מפתח הפיתוח של API שיצרת.
- בחר שמור והענק גישה.
- בחר הרשה כדי להעניק ל-Ally הרשאה להשתמש במפתח הפיתוח של Canvas.
ברקע, Ally יבצע בדיקה מהירה (מינימלית) כדי לוודא שהטווחים הנכונים נוספו במפתח הפיתוח של Canvas.
כשהכל תקין, המערכת אמורה לנתב אותך בחזרה לכלי התצורה ולהציג הודעה המציינת שתצורת השילוב נקבעה בהצלחה.