Hvis du har genereret et API-adgangstoken, kan du bruge det til at foretage API-opkald.
Canvas-tokens stemmer overens med Canvas-tilladelser. Hvis din Canvas-konto bliver slettet, eller hvis du ikke længere er administrator, vil dine tokens også blive tilbagekaldt.
Mulighed 1: Foretag et opkald over HTTPS
Alle API-opkald skal også foretages over HTTPS. Adgangstokenet skal inkluderes som en URL-forespørgselsparameter i alle API-opkald til Canvas. For eksempel er slutpunktet for at få fat i brugerens liste over fag:
- GET /api/v1/courses.json
For at hente Bobs liste over fag, og hvis Bobs adgangstoken var "token_of_magical_power", ville du opkalde
- GET /api/v1/courses.json?access_token=token_of_magical_powers
For et detaljeret eksempel på brug af API'et henvises der til grundlæggende API-dokumentation på github.
Mulighed to: Foretag et opkald ved hjælp af en anmodningsoverskrift
Den anden måde at foretage et API-opkald med et adgangstoken på er ved at tilføje det til anmodningsoverskriften. Hvis du bruger curl (et kommandolinjeprogram, der kan bruges til at køre API-anmodninger), vil du angive adgangstokenet på denne måde.
- curl -H "Authorization: Bearer <token>" 'https://<canvas>/api/v1/accounts/<account_id>/courses.json'
Bemærk, at access_token slet ikke er i URL'en.
Se eksemplet på API dokumentationssiden.
