Para integrar seu SIA ao Google Sala de Aula, valide se o produto atende aos requisitos de parceria do Google Sala de Aula executando o conjunto de testes de conformidade fornecido.
Acessar e executar os testes
Acesse os testes de conformidade no GitHub. Para executar os testes, você precisa do seguinte:
- URL do token para recuperar as credenciais do OAuth 2.0
- URL do OneRoster que termina em
/ims/oneroster/v1p1
- ID do cliente
- Chave secreta do cliente
- Um endereço de e-mail do professor
O pacote de testes tem três seções:
- Sincronização de notas básica
- Categorias de nota
- Períodos de avaliação
É possível executar os testes usando o Google Colab ou o notebook Jupyter. O Colab e o Jupyter Notebook permitem executar todos os testes de uma só vez. Isso ajuda a gerar os resultados do teste para compartilhar com a equipe do Google Sala de Aula.
Requisitos e comportamento esperado do SIS
Os testes definidos pelo Google existem para manter a consistência e minimizar os erros que os usuários podem encontrar ao usar integrações do SIA com o Google Sala de Aula. Leia as seguintes orientações sobre os testes. No GitHub, cada teste tem um título que é referenciado nos ponteiros. Tenha em mente que os ponteiros podem ajudar a esclarecer as perguntas, mas não é uma lista completa dos testes. Verifique se você realizou todos os testes fornecidos no GitHub.
Sincronização de notas básica
Teste | Ponteiros |
---|---|
Professores: GetAllTeachers | O endpoint GET /teachers é chamado com um parâmetro de consulta limit . Em testes subsequentes, esse parâmetro é usado para garantir que o produto ofereça suporte a um tamanho de página de 10.000. |
Professores: GetAllTeachers com filtro de e-mail | O endpoint GET /teachers é chamado com um parâmetro de consulta filter usado para filtrar com base no endereço de e-mail de um professor. O endereço de e-mail do professor que você informou na seção "Credenciais" dos testes será usado. |
Classes: GetClassesForTeacher | O endpoint /teachers/{teacher_sourced_id}/classes é chamado com um parâmetro de consulta filter usado para filtrar com base em classes ativas. |
Alunos: GetStudentsForClass | O endpoint GET /classes/{class_sourced_id}/students é chamado. O e-mail do estudante precisa ser retornado na resposta. |
LineItem: Criar | As categorias ou períodos de avaliação não são necessários ao chamar PUT /lineItems/{line_item_sourced_id} . |
LineItem: Editar | A chamada de API não deve retornar um erro se um título de atividade longo for incluído. O teste inclui um título de atividade com mais de 100 caracteres. |
Resultado: editar | É possível definir score como um valor maior que resultValueMax para representar crédito extra. |
Resultado: excluir | O endpoint DELETE /results/{result_sourced_id} é obrigatório. |
LineItem (opcional / limpeza): excluir e receber | O endpoint DELETE /lineItems/{line_item_sourced_id} não é obrigatório. Ele é opcional e usado para limpar dados. O endpoint GET /classes/{class_sourced_id}/lineItems subsequente também é opcional e testa se o item de linha foi excluído. |
Categorias de nota
Teste | Ponteiros |
---|---|
GetAllCategories ou GetCategoriesForClass | É necessário apenas um endpoint GET /categories , GetAllCategories ou GetCategoriesForClass. Comente o que você não está usando se estiver executando todos os testes de uma só vez. |
DeleteLineItem (opcional / limpeza) | O teste DeleteLineItem é opcional e pode ser usado para limpeza de dados. |
Períodos de avaliação
Teste | Ponteiros |
---|---|
GetGradingPeriodsForTerm | O suporte a períodos de avaliação é testado recuperando o term_sourced_id no teste de filtro GetAllClasses. Esse term_sourced_id é usado para recuperar os períodos de avaliação no período chamando o endpoint GET terms/{term_sourced_id}/gradingPeriods no teste GetGradingPeriodsForTerm. |
Compartilhar os resultados do teste com a equipe do Google Sala de Aula
Depois de executar os testes, um relatório completo com os resultados de cada teste é gerado. Esses testes são usados para determinar se o produto atende aos requisitos de consumo do OneRoster 1.1 do Google. Faça o download ou tire uma captura de tela do relatório gerado. Envie por e-mail o relatório e um link para a certificação do OneRoster 1.1 do seu produto para classroom-sis-external@google.com.
Receber suporte
Envie um e-mail para classroom-sis-external@google.com se tiver dúvidas.