Hvis du hargenerert et API-tilgangssymbol, kan du bruke det til å foreta API-anrop.
Canvas-symboler samsvarer med Canvas-tillatelser. Hvis Canvas-kontoen slettes, eller hvis du ikke lenger er administrator, vil også symbolene bli inndratt.
Alternativ en: Gjør et anrop via HTTPS
Alle API-anrop må også gjøres via HTTPS. Tilgangssymbolet må inkluderes som en URL-spørringsparameter i alle API-anrop til Canvas. Endepunktet for å hente brukerens emneliste er for eksempel:
- GET /api/v1/courses.json
Hvis du vil hente Bobs liste, og hvis Bobs tilgangssymbol var "token_of_magical_power", kunne du ringe
- GET /api/v1/courses.json?access_token=token_of_magical_powers
Vil du ha et detaljert eksempel på bruk av API, kan du sjekke den grunnleggende API-dokumentasjonen på github.
Alternativ to: Foreta et anrop ved hjelp av en forespørselsoverskrift
Den andre måten å foreta et API-anrop med et tilgangssymbol på er å legge det til i forespørselsoverskriften. Hvis du bruker curl (et kommandolinjeprogram som kan brukes til å kjøre API-forespørsler), angir du tilgangssymbolet på denne måten.
- curl -H "Authorization: Bearer <token>" 'https://<canvas>/api/v1/accounts/<account_id>/courses.json'
Merk at tilgangssymbolet (access_token) er ikke i URL i det hele tatt.
Se eksempelet på siden for API dokumentasjon.
