Als je een API-toegangstoken hebt gegenereerd, kun je deze gebruiken voor het verzenden van API-oproepen.
Canvas-tokens zijn gekoppeld aan Canvas-machtigingen. Als je Canvas-account is verwijderd of je niet langer een beheerder bent, zullen je tokens worden ingetrokken.
Optie één: Een oproep verzenden via HTTPS
Alle API-oproepen moeten via HTTPS worden verzonden. Het token moet als een URL-queryparameter worden opgenomen in elke API-oproep die naar Canvas worden verzonden. Het eindpunt om de gebruikerslijst van cursussen op te pikken is bijvoorbeeld:
- GET /api/v1/courses.json
Om Bobs lijst van de cursus op te halen en wanneer Bobs toegangstoken "token_of_magical_power" was, dan zou je moeten oproepen:
- GET /api/v1/courses.json?access_token=token_of_magical_powers
Raadpleeg de API basics documentatie op github voor een gedetailleerd voorbeeld van het gebruik van de API.
Optie twee: Een oproep verzenden via een aanvraagkop
De andere manier om een API-oproep met een toegangstoken te verzenden is om het toe te voegen aan de aanvraagkop. Als je curl gebruikt (een opdrachtregelprogramma dat kan worden gebruikt voor het uitvoeren van API-verzoeken) zou je het toegangstoken als volgt moeten opgeven:
- curl -H "Authorization: Bearer <token>" 'https://<canvas>/api/v1/accounts/<account_id>/courses.json'
Merk op dat het toegangstoken zich in het geheel niet in de URL bevindt.
Bekijk het voorbeeld op de Documentatiewebsite van de API.
