Hvordan tilføjer jeg en udvikler-API-nøgle til en konto?
Som administrator kan du oprette udvikler-API-nøgler til rodkonti. En udvikler-API-nøgle er en kode, som gives til udvikleren af en tredjepartsapplikation, der giver adgang til visse oplysninger og tilladelser i Canvas. Udvikler-API-nøgler kan bruges til at skabe brugerdefinerede integrationer med Canvas og lade tredjepartsapps bruge Canvas-godkendelse. Udvikler-API-nøglen bruger OAuth2 til at gøre det muligt for applikationen at bruge Canvas til godkendelse. For mere information om OAuth2 henvises der til Instructure API OAuth-dokumentationen.
Udvikler-API-nøglen sendes fra applikationen til Canvas, når en bruger anmoder om adgang. Applikationen beder brugeren om tilladelse til programmæssigt at oprette et API-adgangs-token. Når brugeren godkender applikationen, får tredjepartsapplikationen samme adgang til oplysninger og kontotilladelser som den bruger, der gav adgang. For mere information om udviklerdokumenter henvises der til Instructure Github-siden.
Nøgle-områdeafgrænsning
Udvikler-API-nøgler inkluderer funktionalitet til nøgle-områdeafgrænsning som en del af tilføjelsen af en udvikler-API-nøgle. Nøgle-områdeafgrænsning giver dig mulighed for at kontrollere direkte adgang til specifikke API-slutpunkter for tredjepartsværktøjer.
Bemærk: Udvikler-nøgler er en kontotilladelse. Hvis du ikke kan se linket Udvikler-nøgler i Kontonavigation, er denne tilladelse ikke blevet aktiveret for din brugerkonto.
Åbn konto

I Global Navigation skal du klikke på Admin linket [1], klik derefter på kontonavnet [2].
Åbn udvikler-nøgler

Klik på Kontonavigation i linket Udvikler-nøgler (Developer Keys).
Tilføj udvikler-nøgle

Klik på knappen Tilføj udvikler-nøgle (Add Developer Key).
Tilføj API-nøgle

Klik på muligheden Tilføj API-nøgle (Add API Key).
Indtast nøgleindstillinger
Indtast indstillingerne for udvikler-API-nøglen:
- Nøglenavn [1]: Normalt dit app- eller firmanavn. Dette felt vises, når brugere bliver bedt om at godkende adgang til deres Canvas-konto på dine vegne.
- E-mailens ejer [2]: E-mailen til den person, der ejer udviklerværktøjet.
- Omdiriger URI'er [3]: De domæner, hvor der anmodes om tokens. Disse URI'er er ikke din Canvas-URL. Brug https for at undgå bekymringer om blandet indhold i browseren.
- Omdirigerings-URI (ældre) [4]: URI'en for nøgleomdirigeringen. Dette felt giver dig mulighed for at indstille den tidligere URI for et værktøj. Dette felt fjernes senere.
- Leverandørkode (LTI 2) [5]: En unik registreret kode, der identificerer tredjepartsværktøjets leverandør eller udvikler. Dette er specifikt til LTI 2-værktøjer og -apps.
- Ikon-URL [6]: URL'en til dit udviklerværktøjs ikon. Denne URL præsenteres for brugeren for at godkende autorisation af dit værktøj. Brug https for at undgå bekymringer om blandet indhold i browseren.
- Bemærkninger [7]: Eventuelle bemærkninger om udvikler-nøglen, f.eks. grunden til at den blev oprettet.
- Kun testklynge [8]: Opretter en udvikler-nøgle, som kun kan bruges i Canvas-testmiljøet.
- Håndhæv anvendelsesområder [9]: Lader dig tilpasse adgangen til nøglen. Ellers har nøglen adgang til alle slutpunkter, der er tilgængelige for den autoriserende bruger.
Gem nøgle

Klik på knappen Gem (Save) [2].