Skip to main content

Configurare l'integrazione dell'API REST con la chiave sviluppatore di Canvas

Canvas Developer Key è un'alternativa affidabile all'approccio del token di accesso, in quanto qualsiasi endpoint REST Canvas (ambito) può essere abilitato o disabilitato per le integrazioni.

Per configurare l'integrazione dell'API REST è necessario eseguire le seguenti operazioni

  1. Creare una chiave sviluppatore API nell'ambiente Canvas

  2. Configurare Ally con la chiave sviluppatore Canvas

Creare una chiave sviluppatore API

Una chiave sviluppatore API Canvas è essenzialmente una coppia di ID chiave e segreto combinata con una configurazione di ambito specifica.

  1. Vai all'account root dell'istanza Canvas e vai a Chiavi sviluppatore.

  2. Seleziona il pulsante + Chiave sviluppatore e seleziona Chiave API.

  3. Fornisci un nome chiave e email del proprietario.

  4. Copia e incolla questo link nel campo URI di reindirizzamento. Sostituisci [AllyEnvironment] con le informazioni sull'ambiente in cui è ospitato l'istituto. Sostituisci [ClientID] con il tuo ID cliente.

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

  5. Selezionare l'interruttore Applica ambiti per attivarlo.

  6. Selezionare la casella di controllo Consenti parametri di inclusione.

  7. Abilitare questi ambiti dalla tabella:

    Tabella 7. Abilitare questi ambiti

    Nome ambito

    Sezione

    url:GET|/api/v1/accounts

    Account

    url:GET|/api/v1/accounts/:id

    Account

    url:GET|/api/v1/accounts/:account_id/sub_accounts

    Account

    url:GET|/api/v1/accounts/:account_id/courses

    Account

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

    Assegnazioni

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

    Assegnazioni

    url:PUT|/api/v1/corsi/:course_id/compiti/:id

    Assegnazioni

    url:GET|/api/v1/courses/:course_id/blueprint_subscriptions

    Corsi Blueprint

    url:GET|/api/v1/courses/:course_id/blueprint_subscriptions/:subscription_id/migrations

    Corsi Blueprint

    url:GET|/api/v1/courses/:course_id/content_migrations

    Migrazioni dei contenuti

    url:GET|/api/v1/courses/:id

    Corsi

    url:PUT|/api/v1/courses/:id

    Corsi

    url:POST|/api/v1/corsi/:course_id/file

    Corsi

    url:GET|/api/v1/courses/:course_id/discussion_topics

    Argomenti di discussione

    url:GET|/api/v1/courses/:course_id/discussion_topics/:topic_id

    Argomenti di discussione

    url:PUT|/api/v1/courses/:course_id/discussion_topics/:topic_id

    Argomenti di discussione

    url:GET|/api/v1/accounts/:account_id/terms

    Termini di iscrizione

    url:GET|/api/v1/courses/:course_id/files

    File

    url:GET|/api/v1/courses/:course_id/files/:id

    File

    url:PUT|/api/v1/files/:id

    File

    url:DELETE|/api/v1/files/:id

    File

    url:GET|/api/v1/courses/:course_id/media_objects

    Oggetti multimediali

    url:PUT|/api/v1/media_objects/:media_object_id

    Oggetti multimediali

    url:GET|/api/v1/media_objects/:media_object_id/media_tracks

    Oggetti multimediali

    url:PUT|/api/v1/media_objects/:media_object_id/media_tracks

    Oggetti multimediali

    url:GET|/api/v1/courses/:course_id/pages

    Pagine

    url:GET|/api/v1/courses/:course_id/pages/:url_or_id

    Pagine

    url:PUT|/api/v1/corsi/:course_id/pagine/:url_or_id

    Pagine

    url:GET|/api/v1/courses/:course_id/quizzes

    Quiz

    url:GET|/api/v1/courses/:course_id/quizzes/:id

    Quiz

    url:PUT|/api/v1/courses/:course_id/quizzes/:id

    Quiz



  8. Seleziona Salva.

  9. La nuova chiave viene aggiunta alla pagina Chiavi sviluppatore ed è Off per impostazione predefinita.

  10. Accendi la nuova chiave.

  11. Copia il numero ID della chiave nella colonna Dettagli.

Ambiente Ally per la tua regione

Utilizza le informazioni per l'ambiente Ally in cui è ospitato il tuo istituto.

  • Centro dati Stati Uniti: prod.ally.ac

  • Centro dati canadese: prod-ca-central-1.ally.ac

  • Centro dati europeo: prod-eu-central-1.ally.ac

  • Centro dati di Singapore: prod-ap-southeast-1.ally.ac

  • Centro dati australiano: prod-ap-southeast-2.ally.ac

Configura Ally con la chiave sviluppatore

Devi aver effettuato l'accesso sia all'ambiente Canvas che alla pagina di configurazione di Ally.

  1. Vai alla pagina di configurazione di Ally e seleziona la scheda Chiave sviluppatore Canvas.

  2. Seleziona Configura Ally con la chiave sviluppatore Canvas.

  3. Copia e incolla la chiave e il segreto della chiave sviluppatore API che hai creato.

  4. Seleziona Salva e concedi l'accesso.

  5. Seleziona Autorizza per concedere ad Ally l'autorizzazione a utilizzare la chiave sviluppatore Canvas.

In background, Ally eseguirà un controllo rapido (minimo) per assicurarsi che siano stati aggiunti gli ambiti corretti nella chiave sviluppatore Canvas.

Se tutto va bene, dovresti essere reindirizzato allo strumento di configurazione con un messaggio che dice che l'integrazione è stata configurata correttamente.