Resumo
O uso do Qwickly Attendance com Canvas geralmente não exige a aplicação de escopos, mas algumas instituições podem optar por ativá-los por questões de segurança. Caso os escopos estejam ativados, é necessário garantir que a chave do desenvolvedor inclua todas as permissões requeridas para evitar erros como "invalid_scope" ao iniciar o aplicativo.
Aplicar escopos não é obrigatório para usar o Qwickly Attendance com o Canvas.
Por padrão, o Qwickly Attendance funcionará corretamente sem a necessidade de ativar Aplicar Escopos na Chave de Desenvolvedor do Canvas. A maioria das instituições pode concluir sua integração sem modificar as configurações de escopo.
Algumas instituições optam por aplicar escopos como parte de suas políticas internas de segurança. Se sua instituição ativou Aplicar Escopos, você deve garantir que a Chave de Desenvolvedor do Qwickly Attendance inclua todas as permissões necessárias. Sem os escopos exigidos, os usuários podem encontrar um erro “invalid_scope” ao iniciar o aplicativo.
Como Saber se os Escopos Estão Aplicados?
No Canvas, navegue até Admin > Developer Keys > Chave API do Qwickly Attendance > ícone de lápis para editar. Se os escopos estiverem ativados, você verá o controle deslizante 'Aplicar Escopos' ativado:
Nota Importante: Se você estiver usando uma chave de desenvolvedor com escopos aplicados, por favor, certifique-se de marcar a caixa intitulada "Permitir Parâmetros Include"
Permissões Necessárias
Se sua instituição aplica escopos, as seguintes permissões devem ser ativadas na Chave de Desenvolvedor do Qwickly Attendance:
Contas
- Escopo: url:GET|/api/v1/accounts/:account_id/sub_accounts
- Descrição: Lista contas que são subcontas da conta fornecida.
- Escopo: url:GET|/api/v1/accounts/:account_id/courses
- Descrição: Recupera uma lista paginada de cursos nesta conta.
Usuários
- Escopo: url:GET|/api/v1/users/:id
- Descrição: Mostra detalhes de um usuário especificado.
- Escopo: url:GET|/api/v1/users/:user_id/profile
- Descrição: Retorna dados do perfil do usuário, incluindo ID do usuário, nome e URL da imagem do avatar
Administradores
- Escopo: url:GET|/api/v1/accounts/:account_id/admins
- Descrição: Uma lista paginada dos administradores na conta.
Registro de Alteração de Notas
- Escopo: url:GET|/api/v1/audit/grade_change/courses/:course_id
- Descrição: Lista eventos de alteração de notas para um curso específico.
Cursos
- Escopo: url:GET|/api/v1/courses/:id
- Descrição: Retorna informações sobre um único curso.
- Escopo: url:GET|/api/v1/courses/:course_id/users
- Descrição: Retorna uma lista paginada de usuários em um curso.
Funções
- Escopo: url:GET|/api/v1/accounts/:account_id/roles
- Descrição: Uma lista paginada dos papéis disponíveis para uma conta.
Matrículas
- Escopo: url:GET|/api/v1/courses/:course_id/enrollments
- Descrição: Retorna uma lista paginada de todas as matrículas em um curso.
Grupos
- Escopo: url:GET|/api/v1/courses/:course_id/groups
- Descrição: Retorna a lista paginada de grupos ativos no contexto dado que são visíveis para o usuário.
- Escopo: url:GET|/api/v1/groups/:group_id/users
- Descrição: Retorna uma lista paginada de usuários no grupo.
Seções
- Escopo: url:GET|/api/v1/courses/:course_id/sections
- Descrição: Uma lista paginada das seções deste curso.
Tarefas
- Escopo: url:GET|/api/v1/courses/:course_id/assignments
- Descrição: Retorna a lista paginada de tarefas para o curso atual ou grupo de tarefas.
- Escopo: url:GET|/api/v1/courses/:course_id/assignments/:id
- Descrição: Retorna a tarefa com o id fornecido.
- Escopo: url:POST|/api/v1/courses/:course_id/assignments
- Descrição: Cria uma nova tarefa para este curso. A tarefa é criada no estado ativo.
- Escopo: url:PUT|/api/v1/courses/:course_id/assignments/:id
- Descrição: Modificar uma tarefa existente.
- Escopo: url:DELETE|/api/v1/courses/:course_id/assignments/:id
- Descrição: Excluir a tarefa fornecida.
Envios
- Escopo: url:GET|/api/v1/courses/:course_id/assignments/:assignment_id/submissions
- Descrição: Retorna uma lista paginada de todos os envios existentes para uma tarefa.
- Escopo: url:PUT|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id
- Descrição: Comentar e/ou atualizar a avaliação da submissão da tarefa de um aluno. Se quaisquer argumentos submission ou rubric_assessment forem fornecidos, o usuário deve ter permissão para gerenciar notas no contexto apropriado (curso ou seção).
Tópicos de Discussão
- Escopo: url:GET|/api/v1/courses/:course_id/discussion_topics
- Descrição: Retorna a lista paginada de tópicos de discussão para este curso ou grupo.
- Escopo: url:GET|/api/v1/courses/:course_id/discussion_topics/:topic_id/entries
- Descrição: Recuperar as entradas de nível superior (paginadas) em um tópico de discussão.
Questionários
- Escopo: url:GET|/api/v1/courses/:course_id/quizzes
- Descrição: Retorna a lista paginada de Questionários neste curso.
Envios de Questionários
- Escopo: url:GET|/api/v1/courses/:course_id/quizzes/:quiz_id/submissions
- Descrição: Obtém uma lista de todas as submissões para este quiz. Usuários que podem visualizar ou gerenciar notas de um curso terão submissões de múltiplos usuários retornadas. Um usuário que pode apenas enviar terá apenas suas próprias submissões retornadas. Quando um usuário tem uma submissão em andamento, apenas essa submissão é retornada. Quando não há uma submissão de quiz em andamento, todas as submissões concluídas, incluindo tentativas anteriores, são retornadas.
Além disso, usuários do Aplicativo Móvel Qwickly Attendance Student também devem aplicar o seguinte escopo:
Cursos
- Escopo: url:GET|/api/v1/users/:user_id/courses
- Descrição: Retorna uma lista paginada de cursos para o estudante informado.
Solução de problemas: Erro “invalid_scope”
Se sua instituição aplica restrições de escopo LTI e um ou mais escopos necessários não estão habilitados, você pode encontrar um erro “invalid_scope” ao iniciar o aplicativo.
Este erro indica que o Canvas não concedeu todas as permissões necessárias para que a integração funcione corretamente.
Exemplo de mensagem de erro:
Como resolver este problema
Revise a mensagem de erro exibida na página.
Localize a URL do escopo sublinhada (por exemplo:
url:GET|/api/v1/accounts/:account_id/courses).Esta URL identifica a permissão específica que está faltando.
-
Atualize sua Chave de Desenvolvedor LTI ou as configurações de integração no Canvas para incluir o escopo que está faltando:
Faça login no Canvas como administrador.
Navegue até Admin → Developer Keys.
Localize a Chave de Desenvolvedor usada para a integração do Qwickly Attendance.
Selecione Editar Chave.
Na seção Escopos, certifique-se de que o escopo ausente mostrado na mensagem de erro esteja habilitado.
Salve as alterações.
Reinicie a ferramenta Qwickly Attendance.
Salve suas alterações e reinicie o aplicativo.
Notas adicionais
A URL do escopo sublinhada fornece informações precisas sobre qual permissão deve ser habilitada.
Seu administrador do Canvas pode precisar atualizar essas configurações se você não tiver acesso.
Se você não souber como atualizar os escopos, entre em contato com seu administrador do Canvas ou com o representante de suporte do Qwickly.
Comentários
0 comentários
iniciar sessão para comentar.