Sut ydw i’n gwneud galwadau API mewn cyfrif gyda chod mynediad?

Os ydych chi wedi creu tocyn mynediad API, gallwch chi ei ddefnyddio i wneud galwadau API.

Mae tocynnau Canvas yn cyfateb â hawliau Canvas. Os yw eich cyfrif Canvas wedi cael ei ddileu neu os nad ydych chi bellach yn weinyddwr, bydd eich tocynnau hefyd yn cael eu gwrthod.

Opsiwn Un: Gwneud Galwad Dros HTTPS


GET /api/v1/courses.json

Rhaid i bob galwad API gael ei gwneud dros HTTPS. Rhaid i’r tocyn mynediad gael ei gynnwys fel paramedr ymholiad URL mewn unrhyw alwadau API sy’n cael eu gwneud i Canvas. Er enghraifft, y pwynt gorffen i gael gafael ar restr cyrsiau’r defnyddiwr yw:

  • GET /api/v1/courses.json

I nôl rhestr cyrsiau Bob os mai tocyn mynediad Bob yw "token_of_magical_power" byddech chi’n galw

  • GET /api/v1/courses.json?access_token=token_of_magical_powers

I gael enghraifft fanwl o ddefnyddio’r API, edrychwch ar y dogfennau sylfeini API ar github.

Opsiwn Dau: Gwneud Galwad Gan Ddefnyddio Pennyn Cais

Opsiwn Dau: Gwneud Galwad Gan Ddefnyddio Pennyn Cais

Y ffordd arall o wneud galwad API gyda thocyn mynediad yn i’w ychwanegu at bennyn cais.  Os ydych chi’n defnyddio curl (rhaglen llinell orchymyn y gellir ei defnyddio i redeg ceisiadau API) byddech chi’n nodi’r tocyn mynediad fel hyn.  

  • curl -H "Authorization: Bearer <token>" 'https://<canvas>/api/v1/accounts/<account_id>/courses.json'

Sylwch nad yw access_token yn yr URL o gwbl.

Gweler yr enghraifft ar y wefan dogfennau API.