Skip to main content

Configurar a integração da API REST com a chave do desenvolvedor do Canvas

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 habilitado ou deshabilitado 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 no seu ambiente Canvas

  2. Configurar o Ally com a chave do desenvolvedor do Canvas

Criar uma chave de desenvolvedor de 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. Clique no 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 URLs. Substitua [AllyEnvironment] pelas informações ambientais em que a sua instituição está hospedada. Substitua [ClientID] pelo seu código de Cliente.

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

  5. Clique na opção Aplicar escopos para ativá-la.

  6. Marque a caixa de seleção Permitir inclusão de parâmetros.

  7. Habilite os escopos a seguir na tabela:

    tabela 7. Habilite 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/exercícios/:código

    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/media_objects

    Objetos de mídia

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

    Objetos de mídia

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

    Objetos de mídia

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

    Objetos de mídia

    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. Clique em 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 de identificação 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 canadense: prod-ca-central-1.ally.ac

  • Centro de dados europeu: prod-eu-central-1.ally.ac

  • Centro de dados de Singapura: prod-ap-southeast-1.ally.ac

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

Configurar o Ally com a chave do desenvolvedor

Você precisa estar logado tanto no ambiente Canvas quanto na 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. Clique em Configurar o Ally com a chave do desenvolvedor do Canvas.

  3. Copie e cole a chave e o segredo da chave de desenvolvedor API que você criou.

  4. Clique em Salvar e conceder acesso.

  5. Clique em Autorizar para conceder permissão ao Ally para utilizar a Chave de 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.