Tässä ohjeessa kerrotaan, miten Canvas Instructure API integroidaan Lumina-videoalustaan. Järjestelmänvalvojat voivat integroida Instructure Canvas API:n ja synkronoida kaikki tiedot Canvasista Luminaan automaattisesti.
Canvas-asiakastunnuksen ja API-avainten luominen
Alla olevien ohjeiden avulla käyttäjät voivat luoda uuden Canvas-asiakastunnuksen ja API-avaimen, jota voidaan käyttää Luminaan integroimiseen.
- Kirjaudu Canvasiin järjestelmänvalvojana.
-
Avaa välilehti Järjestelmänvalvoja ja valitse Kehittäjäavaimet. Napsauta + Kehittäjäavain-painiketta ja valitse + API-avain.
-
Syötä tiedot alla olevan kuvan mukaisesti ja napsauta sitten Tallenna.
- Avaimen nimi: Canvas Auto Sync Key
-
Uudelleenohjauksen URI-osoitteet: https://<YOUR_YUJA_DOMAIN>/auth/Canvas
- Yhdysvaltain alue: https://panorama-api.yuja.com/canvas-auth
- Kanadan alue: https://panorama-api-cz.yuja.com/canvas-auth
- EU-alue: https://panorama-api-ez.yuja.com/canvas-auth
- Australian alue: https://panorama-api-az.yuja.com/canvas-auth
- (Valinnainen) Ota käyttöön Pakota käyttöalueet.
Huomautus: Emme suosittele käyttöalueiden pakottamista. Se edellyttää, että Panorama integroidaan uudelleen Canvas API:n kanssa aina, kun Panorama lisää uutta toiminnallisuutta, joka käyttää API:a. Jos et halua edetä näin, varmista, että Pakota käyttöalueet on poistettu käytöstä.
Suositellut käyttöalueet:
Accounts
url:GET|/api/v1/accounts
url:GET|/api/v1/accounts/:id
url:GET|/api/v1/accounts/:account_id/courses
url:GET|/api/v1/accounts/:account_id/sub_accountsAdmins
url:GET|/api/v1/accounts/:account_id/adminsUsers
url:GET|/api/v1/accounts/:account_id/users
url:GET|/api/v1/users/:id/profileRoles
url:GET|/api/v1/accounts/:account_id/rolesEnrollments
url:GET|/api/v1/courses/:course_id/enrollmentsGroups
url:GET|/api/v1/courses/:course_id/groups
url:GET|/api/v1/groups/:group_id/usersAssignments
url:GET|/api/v1/courses/:course_id/assignments
url:GET|/api/v1/courses/:course_id/assignments/:id
-
Aseta tilaksi Päällä ja kopioi talteen Canvasin asiakastunnus myöhempää käyttöä varten.
-
Napsauta seuraavaksi Näytä avain ja kopioi talteen Canvasin API-avain myöhempää käyttöä varten.
Canvas API:n integrointi videoalustaan
Seuraavissa vaiheissa juuri hankittu Canvas API -avain integroidaan videoalustaan.
-
Kirjaudu videoalustaan järjestelmänvalvojana, ja siirry sitten kohtaan Hallintapaneeli.
- Napsauta Integraatiot, ja valitse sitten LMS API -yhteys avattavasta Valitse integraatio -luettelosta.
- Syötä seuraavat tiedot ja napsauta sitten Tallenna.
- Valitse LMS: Canvas
- LMS:n URL-osoite: https://<YOUR_CANVAS_DOMAIN> (Katso aluekohtaiset osoitteet edellisen osion vaiheesta 3.)
- Asiakastunnus: Syötä yllä olevassa osiossa saamasi Canvas-asiakastunnus.
-
Asiakkaan salaisuus: Syötä yllä olevassa osiossa saamasi Canvas API -avain.
-
Napsauta Salli API-käyttöoikeus.
-
Kun olet kirjautuneena Canvasiin järjestelmänvalvojana, valitse Valtuuta antaaksesi Luminalle pääsyn Canvas API:in.
Canvas API -kutsujen hallinta
Kun Canvas API on määritetty, järjestelmänvalvojat voivat mukauttaa, mitkä tiedot synkronoidaan Canvasista Luminaan. Yleisesti suosittelemme, että organisaatiot ottavat kaikki synkronointiasetukset käyttöön tämän toiminnon hyödyntämiseksi.
-
Ota käyttöön haluamasi vaihtoehdot, jotka järjestelmänvalvojat voivat synkronoida Canvasista Luminaan.
- Ota käyttöön Canvas-kurssien synkronointi: Kaikki organisaatiosi Canvasin kurssit synkronoidaan videoalustaan päivittäin.
- Ota käyttöön Canvas-käyttäjien synkronointi: Kaikki organisaatiosi Canvasin käyttäjät, jotka ovat ilmoittautuneet Canvas-kurssille, synkronoidaan videoalustaan päivittäin. Jos käyttäjällä on kaksi eri roolia Canvasissa, videoalusta antaa hänelle ylemmän roolin.
- Ota käyttöön Canvas-ilmoittautumisten synkronointi: Kaikki organisaatiosi Canvasin uudet käyttäjäilmoittautumiset synkronoidaan videoalustaan päivittäin.
- Ota käyttöön Canvas-mukautettujen ryhmien synkronointi: Kaikki Canvas-mukautetut ryhmät tuodaan organisaatiosi Canvasista videoalustaan päivittäin.
- Ota Canvas-alitilin synkronointi käyttöön: Kaikki organisaatiosi liittyvät Canvas-alitilit tuodaan videoalustaan päivittäin.
- Aloita synkronoinnit: Synkronoi kaikki yllä olevat käyttöön otetut vaihtoehdot organisaatiosi Canvasista videoalustaan heti.
- Napsauta Tallenna muutokset ottaaksesi kaikki muutokset käyttöön.
Canvas API -kutsujen ilmoitusten määrittäminen
Järjestelmänvalvojat voivat määrittää käyttäjän, joka saa kaikki Canvas API -kutsujen ilmoitukset.
-
Anna Ilmoitukset-osiossa sen YuJa-käyttäjän tunnus, jonka kautta haluat vastaanottaa ilmoituksia.
- Napsauta Tallenna muutokset ottaaksesi kaikki muutokset käyttöön.
Canvas API:n linkitysasetusten määrittäminen
Järjestelmänvalvojat voivat määrittää linkitysasetukset, jotta kurssit ja käyttäjät voidaan luoda Luminaan Canvasista Canvas API:n kautta.
-
Valitse kohdassa Canvas-kurssit Käytä kurssikoodia ja lukukautta varakenttinä, jos Canvas-kurssitunnusta ei löydy -valintaruutu.
Huomautus: Jos haluat hakea vain LTI:n kautta luotuja videoalustan kursseja, valitse Jätä huomiotta ei-LTI-YuJa-kurssit synkronoitaessa Canvas-kursseja -valintaruutu.
- Valitse kohdassa Canvas-käyttäjät avattavasta valikosta Ensisijainen linkitysmäärite.
-
Valitse Käytä käyttäjän sähköpostiosoitetta ja nimeä varakenttinä, jos Canvas-käyttäjätunnusta ei löydy -valintaruutu.
Huomautus: Jos haluat hakea vain LTI:n kautta luotuja videoalustan käyttäjiä, valitse Jätä huomiotta ei-LTI-YuJa-käyttäjät synkronoitaessa Canvas-käyttäjiä -valintaruutu.
- Napsauta Tallenna muutokset ottaaksesi kaikki muutokset käyttöön.