La una chiave sviluppatore Canvas è una valida alternativa al token di accesso poiché qualsiasi endpoint REST Canvas (ambito) può essere abilitato o disabilitato per le integrazioni.

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

  1. Creare una chiave per sviluppatori API nell'ambiente Canvas
  2. Configurare Ally con la chiave sviluppatore Canvas

Creare una chiave sviluppatore API

Una chiave per sviluppatori API Canvas consiste essenzialmente in un ID chiave combinato a una coppia segreta con una configurazione di ambito specifica.

  1. Vai all'account root dell'istanza di Canvas e cerca le chiavi sviluppatore.
  2. Seleziona il pulsante + chiave sviluppatore e la chiave API.
  3. Fornisci un Nome chiave e un'E-mail proprietario.
  4. Copia e incolla questo link nel campo Reindirizza URI. Sostituisci [AllyEnvironment] con le informazioni dell'ambiente nel quale è ospitato il tuo istituto. Sostituisci [ClientID] con il tuo ID client.

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

  5. Seleziona il pulsante di attivazione/disattivazione Applica ambiti per attivarlo.
  6. Spunta la casella Consenti includi parametri.
  7. Abilita questi ambiti dalla tabella:
    Abilita 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 Compiti
    url:GET|/api/v1/courses/:course_id/assignments/:id Compiti
    url:PUT|/api/v1/courses/:course_id/assignments/:id Compiti
    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 contenuti
    url:GET|/api/v1/courses/:id Corsi
    url:PUT|/api/v1/courses/:id Corsi
    url:POST|/api/v1/courses/:course_id/files 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/pages Pagine
    url:GET|/api/v1/courses/:course_id/pages/:url_or_id Pagine
    url:PUT|/api/v1/courses/:course_id/pages/: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 è  Disattivata  per impostazione predefinita.
  10. Attiva la nuova chiave.
  11. Copia il numero dell'ID della chiave e il segreto nella colonna Dettagli . 

Ambiente Ally per la tua regione

Usa le informazioni dell'ambiente di Ally nel quale è ospitato il tuo istituto.

  • Data center negli USA: prod.ally.ac
  • Data center in Canada: prod-ca-central-1.ally.ac
  • Data center in Europa: prod-eu-central-1.ally.ac
  • Data center a Singapore: prod-ap-southeast-1.ally.ac
  • Data center in Australia: prod-ap-southeast-2.ally.ac

Configurare Ally con la chiave sviluppatore

Devi aver effettuato l'accesso al tuo ambiente Canvas e alla tua pagina Configurazione di Ally.

  1. Vai alla tua pagina Configurazione di Ally e seleziona la scheda Chiavesviluppatore Canvas.
  2. Seleziona Configura Ally con la chiave sviluppatore Canvas.
  3. Copia e incolla la chiave e il segreto della chiave sviluppatore API da te creata.
  4. Seleziona Salva e concedi accesso.
  5. Seleziona Autorizza per concedere ad Ally l'autorizzazione a usare la chiave sviluppatore Canvas.

In background, Ally eseguirà un controllo rapido (minimo) per assicurarsi che gli ambiti corretti siano stati aggiunti alla 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.