Naar YuJa
  1. YuJa Helpcentrum
  2. Videoplatform Lumina
  3. Beheerpaneel
  4. LMS-platformintegratie
  5. Instructure Canvas-integratie

Instructure Canvas API integreren in het videoplatform Lumina

Avatar
YuJa
  • Bijgewerkt

Dit document bevat instructies voor het integreren van de Canvas Instructure API in het videoplatform Lumina. Beheerders kunnen de Instructure Canvas API integreren en automatisch alle informatie van Canvas naar Lumina synchroniseren. 

Canvas-client-ID en API-sleutels genereren

Met de onderstaande instructies kunnen gebruikers een nieuwe Canvas-client-ID en API-sleutel genereren die kunnen worden gebruikt voor de integratie met Lumina.

  1. Meld u als beheerder aan bij Canvas.

  2. Ga naar het tabblad Beheerder en kies Ontwikkelaarssleutels. Klik op de knop + Ontwikkelaarssleutel en selecteer + API-sleutel.

    Instructure Canvas Guide 1.png

  3. Voer de gegevens in zoals hieronder weergegeven en klik vervolgens op Opslaan.

    Enforces scope.png
  • Sleutelnaam: Canvas Auto Sync Key

  • Omleidings-URI's: https://<YOUR_YUJA_DOMAIN>/auth/Canvas

    • VS-zone: https://panorama-api.yuja.com/canvas-auth
    • CAN-zone: https://panorama-api-cz.yuja.com/canvas-auth
    • EU-zone: https://panorama-api-ez.yuja.com/canvas-auth
    • AUS-zone: https://panorama-api-az.yuja.com/canvas-auth
    • (Optioneel) Schakel Bereiken afdwingen in.

    Opmerking: Wij raden af om bereiken af te dwingen. Hierdoor moet u Panorama opnieuw integreren met de Canvas API wanneer Panorama nieuwe functionaliteit toevoegt die gebruikmaakt van de API. Als u hier niet mee verder wilt gaan, zorg er dan voor dat Bereiken afdwingen is uitgeschakeld. 

    Aanbevolen bereiken: 

    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_accounts

    Beheerders
    url:GET|/api/v1/accounts/:account_id/admins

    Gebruikers
    url:GET|/api/v1/accounts/:account_id/users
    url:GET|/api/v1/users/:id/profile

    Rollen
    url:GET|/api/v1/accounts/:account_id/roles

    Inschrijvingen
    url:GET|/api/v1/courses/:course_id/enrollments

    Groepen
    url:GET|/api/v1/courses/:course_id/groups
    url:GET|/api/v1/groups/:group_id/users

    Opdrachten
    url:GET|/api/v1/courses/:course_id/assignments
    url:GET|/api/v1/courses/:course_id/assignments/:id

  1. Zet Status op Aan en noteer de Canvas-client-ID voor later gebruik.

    Instructure Canvas Guide 3.png

  2. Klik vervolgens op Sleutel weergeven en noteer de Canvas API-sleutel voor later gebruik.

    Instructure Canvas Guide 4.png

Canvas API integreren in het videoplatform

De volgende stappen betreffen het integreren van de zojuist verkregen Canvas API-sleutel in het videoplatform.

  1. Meld u als beheerder aan bij het videoplatform, en ga vervolgens naar het Admin Paneel.

    Het videoplatform met de optie Admin Paneel onder het pictogram Hoofdmenu.
  2. Klik op Integraties, en kies vervolgens LMS API in de vervolgkeuzelijst “Integratie selecteren”.
  3. Voer de volgende gegevens in en klik vervolgens op Opslaan.
    • Kies een LMS: Canvas
    • URL-link naar uw LMS: https://<YOUR_CANVAS_DOMAIN> (Raadpleeg stap 3 in de vorige sectie voor de domeinzones.)
    • Client-ID: Voer de Canvas-client-ID uit de bovenstaande sectie in.

    • Client secret: Voer de Canvas API-sleutel uit de bovenstaande sectie in.

      Instructure Canvas Guide 6.png

  4. Klik op API-toegang toestaan.

    Instructure Canvas Guide 7.png

  5. Selecteer terwijl u als beheerder bent aangemeld bij Canvas Autoriseren om Lumina toegang te geven tot de Canvas API.

    Instructure Canvas Guide 8.png

Canvas API-aanroepen beheren

Nu de Canvas API is ingesteld, kunnen beheerders aanpassen welke informatie vanuit Canvas met Lumina wordt gesynchroniseerd. Over het algemeen raden wij aan dat instellingen alle synchronisatie-instellingen inschakelen om van deze functionaliteit te profiteren.

  1. Schakel de gewenste opties in voor beheerders om te synchroniseren van Canvas naar Lumina.

    Instructure Canvas Guide 9.png
    • Canvas-cursussynchronisatie inschakelen: Alle cursussen uit het Canvas van uw organisatie worden dagelijks met het videoplatform gesynchroniseerd.
    • Canvas-gebruikerssynchronisatie inschakelen: Alle gebruikers uit het Canvas van uw organisatie die zijn ingeschreven voor een Canvas-cursus, worden dagelijks met het videoplatform gesynchroniseerd. Voor gebruikers met twee verschillende rollen in Canvas kent het videoplatform de hogere rol toe. 
    • Synchronisatie van Canvas-inschrijvingen inschakelen: Alle nieuwe gebruikersinschrijvingen uit het Canvas van uw organisatie worden dagelijks gesynchroniseerd met het videoplatform.
    • Synchronisatie van Canvas-groepen met aangepaste voorzieningen inschakelen: Alle Canvas-groepen met aangepaste voorzieningen uit het Canvas van uw organisatie worden dagelijks in het videoplatform geïmporteerd.
    • Canvas-subaccountsynchronisatie inschakelen: Alle Canvas-subaccounts die aan uw organisatie zijn gekoppeld, worden dagelijks in het videoplatform geïmporteerd.
    • Synchronisaties starten: Synchroniseer onmiddellijk alle hierboven ingeschakelde opties vanuit het Canvas van uw organisatie met het videoplatform.
  2. Klik op Wijzigingen opslaan om alle wijzigingen toe te passen.

Melding voor Canvas API-aanroepen instellen 

Beheerders kunnen een gebruiker instellen die alle meldingen over Canvas API-aanroepen ontvangt.

  1. Voer in de sectie Meldingen de YuJa-gebruikers-ID in waarmee u meldingen wilt ontvangen.

    Instructure Canvas Guide 10.png
  2. Klik op Wijzigingen opslaan om alle wijzigingen toe te passen.

Koppelingsinstellingen voor de Canvas API instellen

Beheerders kunnen koppelingsinstellingen configureren om cursussen en gebruikers vanuit Canvas via de Canvas API in Lumina in te richten. 

Instructure Canvas Guide 11.png

  1. Vink onder Canvas-cursussen het selectievakje Cursuscode en periode als back-upvelden gebruiken als er geen Canvas-cursus-ID wordt gevonden aan.

    Opmerking: Om alleen te zoeken in cursussen in het videoplatform die via LTI zijn ingericht, vinkt u het selectievakje Niet-LTI YuJa-cursussen negeren bij het synchroniseren van Canvas-cursussen aan.

  2. Selecteer onder Canvas-gebruikers het Primair koppelingskenmerk in het vervolgkeuzemenu.

  3. Vink het selectievakje E-mailadres en naam van de gebruiker als back-upvelden gebruiken als er geen Canvas-gebruikers-ID wordt gevonden aan. 

    Opmerking: Om alleen te zoeken naar gebruikers in het videoplatform die via LTI zijn ingericht, vinkt u het selectievakje Negeer niet-LTI YuJa-gebruikers bij het synchroniseren van Canvas-gebruikers aan.

  4. Klik op Wijzigingen opslaan om alle wijzigingen toe te passen.

Verwante artikelen

Neem contact op met support