หากคุณจัดทำชุดข้อมูลสิทธิ์ใช้งาน API ไว้, คุณสามารถใช้ข้อมูลนี้สำหรับการติดต่อผ่าน API
ชุดข้อมูลของ Canvas จะสอดรับกับสิทธิ์อนุญาตของ Canvas หากบัญชี Canvas ของคุณถูกลบทิ้งหรือหากคุณไม่ใช้ผู้ดูแลระบบอีกต่อไป ชุดข้อมูลของคุณจะถูกเพิกถอนด้วย
ตัวเลือกที่หนึ่ง: ติดต่อผ่าน HTTPS
การติดต่อผ่าน API ทั้งหมดจะต้องดำเนินการผ่าน HTTPS ชุดข้อมูลสิทธิ์ใช้งานจะต้องรวมอยู่ในพารามิเตอร์ส่วนการสืบค้นของ URL ในการติดต่อผ่าน API ที่ทำกับ Canvas เช่น ปลายทางในการเรียกค้นรายการบทเรียนของผู้ใช้คือ:
- GET /api/v1/courses.json
การเรียกค้นรายการบทเรียนของ Bob และหากชุดข้อมูลสิทธิ์ใช้งานของ Bob คือ "token_of_magical_power" then you would call
- GET /api/v1/courses.json?access_token=token_of_magical_powers
ดูรายละเอียดตัวอย่างการใช้ API ได้จากเอกสารกำกับเบื้องต้นสำหรับ API ใน github
ตัวเลือกที่สอง: ติดต่อผ่านหัวเรื่องคำขอ
อีกวิธีในการติดต่อผ่าน API โดยใช้ชุดข้อมูลสิทธิ์ใช้งานคือการเพิ่มข้อมูลไปยังหัวเรื่องคำขอ หากใช้ curl (โปรแกรมบรรทัดคำสั่งที่สามารถใช้เพื่อเรียกใช้คำขอผ่าน API) คุณจะต้องระบุชุดข้อมูลสิทธิ์ใช้งานดังนี้
- curl -H "Authorization: Bearer <token>" 'https://<canvas>/api/v1/accounts/<account_id>/courses.json'
ทั้งนี้ access_token ไม่ถือเป็น URL
ดูตัวอย่างได้จากไซต์เอกสารกำกับ API
