Canvas-utvecklarnyckel är ett robust alternativ till åtkomsttoken eftersom Canvas REST-slutpunkt (omfattning) kan aktiveras eller inaktiveras för integreringar.

För att konfigurera REST API-integrering måste du göra följande:

  1. Skapa en API-utvecklarnyckel i din Canvas-miljö
  2. Konfigurera Ally med Canvas-utvecklarnyckeln

Skapa en API-utvecklarnyckel

En Canvas API-utvecklarnyckel är i princip ett nyckel-ID och en hemlighet i kombination med en specifik omfattningskonfiguration.

  1. Gå till Canvas-instansens rotkonto och sedan till Utvecklarnycklar.
  2. Välj knappen + Utvecklarnyckel och välj API-nyckel.
  3. Ange ett nyckelnamn och ägarens e-post.
  4. Kopiera och klistra in länken i fältet Dirigera om URI:er. Ersätt [AllyEnvironment] med information om den miljö där ditt lärosäte har sin värd. Ersätt ”[ClientID]” med ditt kund-ID.

    https://[AllyEnvironment]/api/v2/[ClientId]/auth/canvas/callback

  5. Välj växlingsknappen Påtvinga omfattningar för att aktivera det.
  6. Markera kryssrutan Tillåt inkludera parametrar.
  7. Aktivera dessa omfattningar från tabellen:
    Aktivera dessa omfattningar
    Omfattningsnamn Avsnitt
    url:GET|/api/v1/accounts Konton
    url:GET|/api/v1/accounts/:id Konton
    url:GET|/api/v1/accounts/:account_id/sub_accounts Konton
    url:GET|/api/v1/accounts/:account_id/courses Konton
    url:GET|/api/v1/courses/:course_id/assignments Uppgifter
    url:GET|/api/v1/courses/:course_id/assignments/:id Uppgifter
    url:PUT|/api/v1/courses/:course_id/assignments/:id Uppgifter
    url:GET|/api/v1/courses/:course_id/blueprint_subscriptions Blueprint-kurser
    url:GET|/api/v1/courses/:course_id/blueprint_subscriptions/:subscription_id/migrations Blueprint-kurser
    url:GET|/api/v1/courses/:course_id/content_migrations Innehållsmigreringar
    url:GET|/api/v1/courses/:id Kurser
    url:PUT|/api/v1/courses/:id Kurser
    url:POST|/api/v1/courses/:course_id/files Kurser
    url:GET|/api/v1/courses/:course_id/discussion_topics Diskussionsämnen
    url:GET|/api/v1/courses/:course_id/discussion_topics/:topic_id Diskussionsämnen
    url:PUT|/api/v1/courses/:course_id/discussion_topics/:topic_id Diskussionsämnen
    url:GET|/api/v1/accounts/:account_id/terms Inskrivningsvillkor
    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 Sidor
    url:GET|/api/v1/courses/:course_id/pages/:url_or_id Sidor
    url:PUT|/api/v1/courses/:course_id/pages/:url_or_id Sidor
    url:GET|/api/v1/courses/:course_id/quizzes Frågesporter
    url:GET|/api/v1/courses/:course_id/quizzes/:id Frågesporter
    url:PUT|/api/v1/courses/:course_id/quizzes/:id Frågesporter
  8. Klicka på Spara.
  9. Den nya nyckeln läggs till på sidan Utvecklarnycklar och är Av som standard.
  10. Aktivera den nya nyckeln.
  11. Kopiera nyckelns ID-nummer i kolumnen Detaljer. 

Ally-miljö för din region

Använd informationen för den Ally-miljö där ditt lärosäte har sin värd.

  • Datacenter i USA: prod.ally.ac
  • Datacenter i Kanada: prod-ca-central-1.ally.ac
  • Datacenter i Europa: prod-eu-central-1.ally.ac
  • Datacenter i Singapore: prod-ap-southeast-1.ally.ac
  • Datacenter i Australien: prod-ap-southeast-2.ally.ac

Konfigurera Ally med utvecklarnyckeln

Du måste vara inloggad både i Canvas-miljön och på din Ally-konfigurationssida.

  1. Gå till din Ally-konfigurationssida och välj fliken Canvas-utvecklarnyckel.
  2. Välj Konfigurera Ally med Canvas-utvecklarnyckel.
  3. Kopiera och klistra in nyckeln och hemligheten för den API-utvecklarnyckel som du har skapat.
  4. Välj Spara och bevilja åtkomst.
  5. Välj Auktorisera för att ge Ally behörighet att använda Canvas-utvecklarnyckeln.

I bakgrunden kommer Ally att köra en snabb (minimal) kontroll för att säkerställa att rätt omfattning har lagts till för Canvas-utvecklarnyckeln.

Om allt går bra bör du omdirigeras tillbaka till konfigurationsverktyget med ett meddelande om att integreringen har konfigurerats korrekt.