ฉันจะเพิ่มคีย์ API ผู้พัฒนาสำหรับบัญชีผู้ใช้ได้อย่างไร

ในฐานะผู้ดูแลระบบ คุณสามารถจัดทำคีย์ API ผู้พัฒนาระบบสำหรับบัญชีราก คีย์ API ผู้พัฒนาเป็นรหัสที่มอบให้แก่ผู้พัฒนาแอพพลิเคชั่นจากภายนอกเพื่อให้สิทธิ์ในการสืบค้นข้อมูลและสิทธิ์อนุญาตบางประการภายใน Canvas คีย์ API ผู้พัฒนาสามารถใช้เพื่อจัดทำส่วนผสานการทำงานแบบกำหนดเองกับ Canvas และช่วยให้แอพจากภายนอกสามารถใช้ระบบตรวจรับรองของ Canvas คีย์ API ผู้พัฒนาใช้ OAuth2 เพื่อเปิดใช้งานแอพพลิเคชั่นสำหรับใช้ Canvas ในการตรวจรับรอง ดูรายละเอียดเพิ่มเติมเกี่ยวกับ OAuth2 ได้จากเอกสารกำกับ Instructure API OAuth

คีย์ API ผู้พัฒนาจะถูกส่งจากแอพพลิเคชั่นไปยัง Canvas เมื่อผู้ใช้แจ้งขอสิทธิ์ใช้งาน แอพพลิเคชั่นจะขอสิทธิ์อนุญาตจากผู้ใช้ในการจัดทำชุดข้อมูลสิทธิ์ใช้งาน API สำหรับโปรแกรมการทำงาน เมื่อผู้ใช้ให้อนุญาตแก่แอพพลิเคชั่น แอพพลิเคชั่นจากภายนอกดังกล่าวจะมีสิทธิ์เดียวกันนี้ในการสืบค้นข้อมูลและสิทธิ์สำหรับบัญชีผู้ใช้ที่เท่าเทียมกับผู้ใช้ที่ให้สิทธิ์ ตรวจสอบข้อมูลเพิ่มเติมเกี่ยวกับเอกสารสำหรับผู้พัฒนาระบบได้จากเพจ Instructure Github

การกำหนดขอบเขตคีย์ (Key Scoping)

คีย์ API ผู้พัฒนาครอบคลุมฟังก์ชั่นในการกำหนดขอบเขตของคีย์สำหรับการเพิ่มคีย์ API ผู้พัฒนา การกำหนดขอบเขตคีย์ช่วยให้คุณสามารถควบคุมการใช้งานอุปกรณ์ปลายทาง API สำหรับเครื่องมือจากภายนอก

หมายเหตุ: คีย์สำหรับผู้พัฒนาเป็นสิทธิ์อนุญาตทางบัญชี หากคุณไม่สามารถดูลิงค์คีย์สำหรับผู้พัฒนา (Developer Keys) ในส่วนการสืบค้นเนื้อหาทางบัญชี (Account Navigation) แสดงว่าสิทธิ์อนุญาตนี้ไม่ได้เปิดใช้งานสำหรับบัญชีผู้ใช้ของคุณ

เปิดบัญชีผู้ใช้

เปิดบัญชีผู้ใช้

จากส่วนการสืบค้นเนื้อหาส่วนกลางให้คลิกที่ลิงค์ ผู้ดูแลระบบ (Admin) [1] จากนั้นคลิกที่ชื่อบัญชี [2]

เปิดคีย์สำหรับผู้พัฒนา

เปิดคีย์สำหรับผู้พัฒนา

จากส่วนการสืบค้นเนื้อหาทางบัญชี (Account Navigation) คลิกที่ลิงค์ คีย์สำหรับผู้พัฒนา (Developer Keys)

เพิ่มคีย์สำหรับผู้พัฒนา

เพิ่มคีย์สำหรับผู้พัฒนา

คลิกที่ปุ่ม เพิ่มคีย์สำหรับผู้พัฒนา (Add Developer Key)

เพิ่มคีย์ API

เพิ่มคีย์ API

คลิกที่ตัวเลือก เพิ่มคีย์ API (Add LTI Key)

กรอกค่าปรับตั้งคีย์

กรอกค่าปรับตั้งคีย์

กรอกค่าสำหรับคีย์ API สำหรับผู้พัฒนาระบบ:

  • ชื่อคีย์ (Key Name) [1]: โดยปกติจะเป็นชื่อแอพหรือชื่อบริษัทของคุณ ฟิลด์นี้จะปรากฏขึ้นเมื่อผู้ใช้ได้รับแจ้งให้รับรองสิทธิ์ใช้งานสำหรับบัญชี Canvas ของตนให้กับคุณ
  • อีเมลเจ้าของ (Owner Email) [2]: อีเมลบุคคลที่เป็นเจ้าของเครื่องมือสำหรับผู้พัฒนาระบบ
  • URI เปลี่ยนเส้นทาง (Redirect URIs) [3]: โดเมนที่มีการแจ้งขอชุดข้อมูล URI เหล่านี้ไม่ใช่ Canvas URL ของคุณ เพื่อไม่ให้เกิดความสัมพันธ์ระหว่างเบราเซอร์ ให้ใช้ https
  • URI เปลี่ยนเส้นทาง (Redirect URI) (เดิม) [4]: URI สำหรับเปลี่ยนเส้นทางคีย์ ฟิลด์นี้ช่วยให้คุณสามารถกำหนด URI ก่อนหน้าสำหรับเครื่องมือ ในท้ายที่สุดฟิลด์นี้จะถูกลบทิ้ง
  • รหัสผู้ให้บริการ (LTI 2) (Vendor Code - LTI2) [5]: รหัสเฉพาะที่ลงทะเบียนไว้เพื่อระบุผู้ให้บริการหรือผู้พัฒนาระบบของเครื่องมือจากภายนอก นี่เป็นรหัสเฉพาะสำหรับเครื่องมือ LTI2 และแอพใช้งาน
  • URL ไอคอน (Icon URL) [6]: URL ของไอคอนสำหรับเครื่องมือสำหรับผู้พัฒนาระบบของคุณ URL นี้จะนำเสนอให้แก่ผู้ใช้เพื่อรับรองการอนุมัติใช้เครื่องมือของคุณ เพื่อไม่ให้เกิดความสัมพันธ์ระหว่างเบราเซอร์ ให้ใช้ https
  • หมายเหตุ (Notes) [7]: หมายเหตุใด ๆ เกี่ยวกับคีย์ผู้พัฒนาระบบ เช่น สาเหตุในการจัดทำ
  • คลัสเตอร์ทดสอบเท่านั้น (Test Cluster Only) [8]: จัดทำคีย์ผู้พัฒนาระบบที่สามารถใช้เพื่อการทดสอบของ Canvas เท่านั้น
  • บังคับใช้ขอบเขต (Enforce Scopes) [9]: คุณสามารถปรับแต่งสิทธิ์ใช้งาสำหรับคีย์ดังกล่าวได้ ไม่เช่นนี้คีย์ดังกล่าวสามารถใช้งานอุปกรณ์ปลายทางทั้งหมดที่มีสำหรับผู้ใช้ที่มีสิทธิ์ในการให้อนุญาต

บันทึกคีย์

บันทึกคีย์

คลิกที่ปุ่ม บันทึก (Save)

ดูคีย์

ดูคีย์

ดูคีย์ผู้พัฒนา (Developer Key) สำหรับบัญชีผู้ใช้ของคุณ