Som administrator kan du opprette API-nøkler for utviklere for rotkontoer. En API-nøkkel for utviklere er en kode som gis til utvikleren av en tredjepartsapplikasjon, og som gir tilgang til visse opplysninger og tillatelser i Canvas. API-nøkler for utviklere kan brukes til å opprette tilpassede integrasjoner med Canvas og gjøre det mulig for tredjepartsapper å bruke Canvas-autentisering. API-nøkkelen for utviklere bruker OAuth2 for å gjøre det mulig for applikasjonen å bruke Canvas til autentisering. Se Instructure API OAuth-dokumentasjonen for mer informasjon om OAuth2.
API-nøkkelen for utviklere sendes fra applikasjonen til Canvas når en bruker ber om tilgang. Applikasjonen ber brukeren om tillatelse til å programmatisk opprette et API-tilgangssymbol. Når brukeren autoriserer applikasjonen, vil tredjepartsapplikasjonen ha samme tilgang til informasjon og kontotillatelser som brukeren som ga tilgang. Se Instructure Github-siden for mer informasjon om utviklerdokumenter.
Nøkkelavgrensning
API-nøkler for utviklere inkluderer funksjonalitet for nøkkelavgrensning som en del av å legge til en API-nøkkel for utviklere. Med nøkkelavgrensning kan du kontrollere direkte tilgang til spesifikke API-endepunkter for tredjepartsverktøy.
Merknad: Utviklernøkler er en konto-tillatelse. Kan du ikke se lenken til utviklernøkkelen i konto-navigering, er ikke denne tillatelsen aktivert for din brukerkonto.
Åpne konto
I Global navigering, klikk Admin-linken [1], og klikk på navnet til kontoen [2].
Åpne utviklernøkler
I Kontonavigering, klikk på lenken Utviklernøkler (Developer Keys).
Legg til utviklernøkkel
Klikk på tasten Legg til utviklernøkkel (Add Developer Key) .
Legg til API-nøkkel
Klikk på alternativet Legg til API-nøkkel (Add API Key).
Angi nøkkelinnstillinger
Angi innstillingene for API-nøkkelen for utviklere:
- Nøkkelnavn [1]: Vanligvis app- eller firmanavnet ditt. Dette feltet vises når brukere blir bedt om å godkjenne tilgang til Canvas-kontoen sin på dine vegne.
- Eierens epost [2]: E-postadressen til personen som eier utviklerverktøyet.
- Omdirigerings-URI-er [3]: Domenene hvor symbolene etterspørres. Disse URI-ene er ikke URL-adressen til Canvas. Bruk https for å unngå problemer med blandet innhold i nettleseren.
- Omdiriger URI (eldre) [4]: URI-en for nøkkelomdirigering. I dette feltet kan du angi den forrige URI-en for et verktøy. Dette feltet vil eventuelt bli fjernet.
- Leverandørkode (LTI 2) [5]: En unik registrert kode som identifiserer leverandøren eller utvikleren av tredjepartsverktøyet. Dette gjelder spesielt for LTI 2-verktøy og -apper.
- Ikon-URL [6]: URL-adressen til ikonet for utviklerverktøyet. Denne URL-adressen vises til brukeren for å godkjenne autorisasjon for verktøyet. Bruk https for å unngå problemer med blandet innhold i nettleseren.
- Merknader [7]: Eventuelle merknader om utviklernøkkelen, for eksempel årsaken til at den har blitt opprettet.
- Kun testklynge [8]: Oppretter en utviklernøkkel som bare kan brukes i Canvas testmiljø.
- Håndheve områder [9]: Lar deg tilpasse tilgang for nøkkelen. Ellers vil nøkkelen ha tilgang til alle endepunkter som er tilgjengelige for den autoriserende brukeren.
Lagre nøkkel
Klikk på tasten Lagre (Save).
Vis nøkkel
Vis utviklernøkkelen for kontoen din.
