Canvas-utviklernøkler er et robust alternativ til tilgangstoken, siden alle Canvas REST-endepunkter (omfang) kan aktiveres eller deaktiveres for integreringer.
For å konfigurere REST API-integreringen må du gjøre følgende:
- Opprett en API-utviklernøkkel i Canvas-miljøet ditt.
- Konfigurer Ally med Canvas-utviklernøkkelen.
Opprett en API-utviklernøkkel
En Canvas API-utviklernøkkel er i all hovedsak en nøkkel-ID og et hemmelig par som er kombinert med en spesifikk konfigurasjon av omfanget.
- Gå til rotkontoen til Canvas-forekomsten, og gå deretter til Utviklernøkler.
- Velg + Utviklernøkkel-knappen, og velg API-nøkkel.
- Oppgi et nøkkelnavn og e-postadressen til eieren.
- Kopier og lim inn denne lenken i feltet Omdiriger URI-er. Erstatt [AllyEnvironment] med informasjonen om miljøet der institusjonen din driftes. Erstatt [ClientID] med klient-ID-en din.
https://[AllyEnvironment]/api/v2/[ClientId]/auth/canvas/callback
- Trykk på Håndheve omfang for å slå det på.
- Merk av i boksen for Tillat inkludering av parametere.
- Aktiver følgende omfang fra tabellen:
Aktiver følgende omfang Navn på omfang Del url:GET|/api/v1/accounts Kontoer url:GET|/api/v1/accounts/:id Kontoer url:GET|/api/v1/accounts/:account_id/sub_accounts Kontoer url:GET|/api/v1/accounts/:account_id/courses Kontoer url:GET|/api/v1/courses/:course_id/assignments Oppgaver url:GET|/api/v1/courses/:course_id/assignments/:id Oppgaver url:PUT|/api/v1/courses/:course_id/assignments/:id Oppgaver url:GET|/api/v1/courses/:course_id/blueprint_subscriptions Blueprint-emner url:GET|/api/v1/courses/:course_id/blueprint_subscriptions/:subscription_id/migrations Blueprint-emner url:GET|/api/v1/courses/:course_id/content_migrations Innholdsoverføringer url:GET|/api/v1/courses/:id Emner url:PUT|/api/v1/courses/:id Emner url:POST|/api/v1/courses/:course_id/files Emner url:GET|/api/v1/courses/:course_id/discussion_topics Diskusjonstemaer url:GET|/api/v1/courses/:course_id/discussion_topics/:topic_id Diskusjonstemaer url:PUT|/api/v1/courses/:course_id/discussion_topics/:topic_id Diskusjonstemaer url:GET|/api/v1/accounts/:account_id/terms Vilkår for påmelding url:GET|/api/v1/courses/:course_id/files Filer url:GET|/api/v1/courses/:course_id/files/:id Filer url:PUT|/api/v1/files/:id Filer url:DELETE|/api/v1/files/:id Filer url:GET|/api/v1/courses/:course_id/pages Sider url:GET|/api/v1/courses/:course_id/pages/:url_or_id Sider url:PUT|/api/v1/courses/:course_id/pages/:url_or_id Sider url:GET|/api/v1/courses/:course_id/quizzes Spørrekonkurranser url:GET|/api/v1/courses/:course_id/quizzes/:id Spørrekonkurranser url:PUT|/api/v1/courses/:course_id/quizzes/:id Spørrekonkurranser - Velg Lagre.
- Den nye nøkkelen legges til på Utviklernøkler-siden og er slått av som standard.
- Slå på den nye nøkkelen.
- Kopier nøkkel-ID-nummeret i Detaljer-kolonnen.
Ally-miljø for området ditt
Bruk informasjonen til Ally-miljøet der institusjonen din driftes.
- Datasenter i USA: prod.ally.ac
- Datasenter i Canada: prod-ca-central-1.ally.ac
- Datasenter i Europa: prod-eu-central-1.ally.ac
- Datasenter i Singapore: prod-ap-southeast-1.ally.ac
- Datasenter i Australia: prod-ap-southeast-2.ally.ac
Konfigurer Ally med utviklernøkkelen
Du må være logget på både Canvas-miljøet og konfigurasjonssiden i Ally.
- Gå til konfigurasjonssiden i Ally, og velg Canvas-utviklernøkkel-fanen.
- Velg Konfigurer Ally med Canvas-utviklernøkkel.
- Kopier og lim inn nøkkelen og hemmeligheten til API-utviklernøkkelen du opprettet.
- Velg Lagre og gi tilgang.
- Velg Authorize (godkjenn) for å gi Ally tillatelse til å bruke Canvas-utviklernøkkelen.
Ally kjører en rask (minimal) kontroll i bakgrunnen for å sikre at de riktige omfangene ble lagt til i Canvas-utviklernøkkelen.
Hvis alt fungerer som det skal, omdirigeres du tilbake til konfigurasjonsverktøyet og får opp en melding om at integreringen ble konfigurert riktig.