A chave do desenvolvedor do Canvas é uma alternativa avançada para o método de código de acesso, pois qualquer ponto de extremidade (escopo) da REST do Canvas pode ser ativado ou desativado para integrações.

Para configurar a integração da API REST, é necessário realizar as etapas abaixo

  1. Criar uma chave do desenvolvedor da API em seu ambiente Canvas
  2. Configurar o Ally com a chave do desenvolvedor do Canvas

Criar uma chave do desenvolvedor da API

Em resumo, uma chave do desenvolvedor da API do Canvas é um par de código e senha combinados com uma configuração de escopo específica.

  1. Acesse a conta raiz da instância do Canvas e, em seguida, acesse Chaves do desenvolvedor.
  2. Selecione o botão + Chave do desenvolvedor e selecione Chave da API.
  3. Forneça um Nome de chave e o E-mail do proprietário.
  4. Copie e cole o link a seguir no campo Redirecionar URIs. Substitua [AllyEnvironment] pelas informações do ambiente em que a instituição está hospedada. Substitua [ClientID] pelo seu código do cliente.

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

  5. Selecione a opção Aplicar escopos para ativá-la.
  6. Marque a caixa de seleção Permitir inclusão de parâmetros.
  7. Ative os escopos a seguir na tabela:
    Ative os escopos a seguir
    Nome do escopo Seção
    url:GET|/api/v1/accounts Contas
    url:GET|/api/v1/accounts/:id Contas
    url:GET|/api/v1/accounts/:account_id/sub_accounts Contas
    url:GET|/api/v1/accounts/:account_id/courses Contas
    url:GET|/api/v1/courses/:course_id/assignments Exercícios
    url:GET|/api/v1/courses/:course_id/assignments/:id Exercícios
    url:PUT|/api/v1/courses/:course_id/assignments/:id Exercícios
    url:GET|/api/v1/courses/:course_id/blueprint_subscriptions Cursos do plano
    url:GET|/api/v1/courses/:course_id/blueprint_subscriptions/:subscription_id/migrations Cursos do plano
    url:GET|/api/v1/courses/:course_id/content_migrations Migrações de conteúdo
    url:GET|/api/v1/courses/:id Cursos
    url:PUT|/api/v1/courses/:id Cursos
    url:POST|/api/v1/courses/:course_id/files Cursos
    url:GET|/api/v1/courses/:course_id/discussion_topics Tópicos de discussão
    url:GET|/api/v1/courses/:course_id/discussion_topics/:topic_id Tópicos de discussão
    url:PUT|/api/v1/courses/:course_id/discussion_topics/:topic_id Tópicos de discussão
    url:GET|/api/v1/accounts/:account_id/terms Períodos de matrícula
    url:GET|/api/v1/courses/:course_id/files Arquivos
    url:GET|/api/v1/courses/:course_id/files/:id Arquivos
    url:PUT|/api/v1/files/:id Arquivos
    url:DELETE|/api/v1/files/:id Arquivos
    url:GET|/api/v1/courses/:course_id/pages Páginas
    url:GET|/api/v1/courses/:course_id/pages/:url_or_id Páginas
    url:PUT|/api/v1/courses/:course_id/pages/:url_or_id Páginas
    url:GET|/api/v1/courses/:course_id/quizzes Questionários
    url:GET|/api/v1/courses/:course_id/quizzes/:id Questionários
    url:PUT|/api/v1/courses/:course_id/quizzes/:id Questionários
  8. Selecione Salvar.
  9. A nova chave é adicionada à página Chaves do desenvolvedor e está desativada por padrão.
  10. Ative a nova chave.
  11. Copie o número do código da chave na coluna Detalhes. 

Ambiente do Ally para sua região

Use as informações do ambiente do Ally em que sua instituição está hospedada.

  • Centro de dados dos EUA: prod.ally.ac
  • Centro de dados do Canadá: prod-ca-central-1.ally.ac
  • Centro de dados da Europa: prod-eu-central-1.ally.ac
  • Centro de dados de Singapura: prod-ap-southeast-1.ally.ac
  • Centro de dados da Austrália: prod-ap-southeast-2.ally.ac

Configurar o Ally com a chave do desenvolvedor

É necessário acessar o ambiente do Canvas e à página de configuração do Ally.

  1. Acesse a página de configuração do Ally e selecione a guia Chave do desenvolvedor do Canvas.
  2. Selecione Configurar o Ally com a chave do desenvolvedor do Canvas.
  3. Copie e cole a chave e a senha da chave do desenvolvedor da API que você criou.
  4. Selecione Salvar e conceder acesso.
  5. Selecione Autorizar para dar permissão ao Ally para usar a chave do desenvolvedor do Canvas.

Em segundo plano, o Ally realizará uma verificação rápida (mínima) para garantir que os escopos corretos foram adicionados à chave do desenvolvedor do Canvas.

Se tudo estiver correto, será exibida uma mensagem informando que a integração foi configurada corretamente e você será redirecionado à ferramenta de configuração.