Als beheerder kun je API-sleutels voor ontwikkelaars voor hoofdaccounts beheren. Een API-sleutel voor ontwikkelaars is een code die aan de ontwikkelaar van een applicatie van derden wordt gegeven om toegang te krijgen tot bepaalde informatie en machtigingen binnen Canvas. Ontwikkelaar-API-sleutels kunnen worden gebruikt om aangepaste integraties te maken met Canvas en stelt externe apps in staat Canvas-verificatie te gebruiken. De API-sleutel voor ontwikkelaars gebruikt OAuth. Dit stelt de applicatie in staat Canvas te gebruiken voor verificatie. Bekijk de Documentatie over API-OAuth van Instructure voor meer informatie.
De API-sleutel voor ontwikkelaars wordt van de applicatie naar Canvas verzonden wanneer een gebruiker om toegang verzoekt. De applicatie vraagt de gebruiker om toestemming om via een programma een API-toegangstoken te maken. Wanneer de gebruiker de applicatie autoriseert, heeft de externe applicatie dezelfde toegang tot informatie en dezelfde accountmachtigingen als de gebruiker die toegang heeft verleend. Ga voor meer informatie over ontwikkelaarsdocumenten naar de pagina Instructure Github.
Sleutel-scoping
API-sleutels voor ontwikkelaars omvatten functionaliteit voor sleutel-scoping als onderdeel van het toevoegen van een API-sleutel voor ontwikkelaars. Met sleutel-scoping kun je controle uitoefenen over de directe toegang tot specifieke API-eindunten voor externe tools.
Opmerking: Ontwikkelaarssleutels is een accountmachtiging. Als je de ontwikkelaarssleutels niet kunt zien in Accountnavigatie, is deze machtiging niet ingeschakeld voor je gebruikersaccount.
Account openen
Klik in Globale navigatie op de link Beheerder (Admin) [1] en klik daarna op de naam van het account [2].
Ontwikkelaarssleutels openen
Klik op de link Ontwikkelaarssleutels (Developer Keys) in Accountnavigatie.
Ontwikkelaarssleutel toevoegen
Klik op de knop Ontwikkelaarssleutel toevoegen (Add Developer Key).
API-sleutel toevoegen
Klik op de optie API-sleutel toevoegen (Add API Key).
De KPI-instellingen invoeren
Voer de instellingen voor de KPI-sleutel voor ontwikkelaars in:
- Naam van sleutel (Key Name) [1] Meestal de naam van je app of bedrijf. Dit veld wordt weergegeven wanneer gebruikers wordt gevraagd namens jou toegang toe te staan tot hun Canvas-account.
- E-mail van de eigenaar (Owner Email) [2]: Het e-mailadres van de eigenaar van de ontwikkelaarstool.
- Omleidings-URI's (Redirect URIs) [3]: De domeinen waar tokens worden aangevraagd. Deze URI's zijn niet je Canvas-URL. Gebruik https om problemen met gemengde inhoud in browsers te voorkomen.
- Omleidings-URI (oud) (Redirect URI (Legacy)) [4]: De URI voor de omleiding van de sleutel. Met dit veld kun je de vorige URI voor een tool instellen. Dit veld wordt op termijn verwijderd.
- Leverancierscode (Vendor Code) (LTI 2) [5]: Een unieke geregistreerde code die de leverancier of de ontwikkelaar van de externe tool identificeert. Dit is specifiek voor LTI 2-tools en -apps
- Pictogram-URL [6]: De URL van het pictogram voor je ontwikkelaarstool Deze URL wordt de gebruiker getoond om de autorisatie voor je tool goed te keuren. Gebruik https om problemen met gemengde inhoud in browsers te voorkomen.
- Opmerkingen (Notes) [7] Alle mogelijke opmerkingen over de ontwikkelaarssleutel, bijvoorbeeld de reden waarom de sleutel is aangemaakt.
- Uitsluitend voor testcluster (Test Cluster Only) [8]: Maakt een ontwikkelaarssleutel die alleen in de testomgeving van Canvas kan worden gebruikt.
- Scopes afdwingen Enforce Scopes [9]: Stelt je in staat de toegang tot de sleutel aan te passen. Anders biedt de sleutel toegang tot alle eindpunten die beschikbaar zijn voor de autoriserende gebruiker.
Sleutel opslaan
Klik op de knop Opslaan (Save).
Sleutel bekijken
Bekijk de ontwikkelaarssleutel voor je account.
