Integrações com sistemas de informações de estudantes (SIEs) que usam o OneRoster

O Google Sala de Aula é compatível com a importação de listas de estudantes e a sincronização de boletins de notas para vários sistemas de informações de estudantes (SIEs) compatíveis com o OneRoster. O Google faz parcerias com plataformas de SIE que atendem aos requisitos do OneRoster especificados pelo Google.

Figura 1. Quando os sistemas de informações de estudantes (SIE) fazem parceria com o Google Sala de Aula, os administradores podem escolher o SIE no menu suspenso.

Jornada de integração de parceiros de SIA

Confira a seguir uma visão geral rápida da jornada de integração do parceiro do SIS:

  1. Manifestar interesse: se você tiver interesse em fazer uma parceria com o Google Sala de Aula, preencha o formulário de interesse.

  2. Analisar e executar os testes de conformidade: para entender se o SIA está pronto para ser integrado ao Google Sala de Aula, consulte os testes de conformidade para se familiarizar com os requisitos do Google. Você pode executar os testes de conformidade antes de manifestar interesse à equipe do Google Sala de Aula para determinar se o produto atende aos requisitos do Google.

  3. Entre em contato com a equipe do Google Sala de Aula: a equipe do Google Sala de Aula vai entrar em contato após o envio do formulário de interesse se houver uma oportunidade de parceria.

  4. Compartilhe os resultados do teste e crie a integração completa: depois que a equipe do Google Sala de Aula entrar em contato com você, compartilhe os resultados do teste de conformidade. Sua equipe vai trabalhar com o Google para validar e concluir a integração.

Testes de conformidade

Os testes de conformidade definidos pelo Google existem para que os parceiros de SIE possam determinar se o produto deles atende aos requisitos de consumo do OneRoster do Google e para minimizar os erros que os usuários podem encontrar ao usar as integrações de SIE no Google Sala de Aula. Os testes são publicados no GitHub.

Acessar e executar os testes

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/v1p2
  • ID do cliente
  • Chave secreta do cliente
  • Endereço de e-mail de um professor

É possível executar os testes usando o Google Colab ou o notebook Jupyter. Tanto o Colab quanto o notebook Jupyter 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

Leia as seguintes dicas sobre os testes. No GitHub, cada teste tem um título que é referenciado na tabela. Essas dicas podem ajudar a esclarecer dúvidas, mas não são uma lista completa dos testes. Execute todos os testes fornecidos no GitHub para garantir a conformidade.

Teste Ponteiros
Professores: GetAllTeachers O endpoint GET /teachers é chamado com um parâmetro de consulta limit. Nos testes seguintes, esse parâmetro é usado para garantir que seu produto seja compatível com 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. Isso vai usar o endereço de e-mail do professor que você forneceu na seção "Credenciais" dos testes.
Turmas: GetClassesForTeacher O endpoint /teachers/{teacher_sourced_id}/classes é chamado com um parâmetro de consulta filter usado para filtrar com base em classes ativas.
Estudantes: GetStudentsForClass O endpoint GET /classes/{class_sourced_id}/students é chamado. O e-mail do estudante precisa ser retornado na resposta.
GetGradingPeriodsForTerm O suporte aos períodos de avaliação é testado usando o term_sourced_id. Esse term_sourced_id é usado para recuperar os períodos de avaliação no período letivo chamando o endpoint GET /terms/{term_sourced_id}/gradingPeriods.
LineItem: Create Os períodos de avaliação não são obrigatórios ao chamar PUT /lineItems/{line_item_sourced_id}.
Item de linha: editar A chamada de API não deve retornar um erro se um título longo de atividade for incluído. O teste inclui um título de atividade com mais de 100 caracteres.
Resultado: editar Deve ser possível definir o score como um valor maior que o resultValueMax para representar crédito extra.
Resultado: excluir O endpoint DELETE /results/{result_sourced_id} é obrigatório.
LineItem (opcional / limpeza): Delete e Get O endpoint DELETE /lineItems/{line_item_sourced_id} não é obrigatório. Ele é opcional e usado para limpeza de dados. O endpoint GET /classes/{class_sourced_id}/lineItems subsequente também é opcional e testa se o item de linha foi excluído.

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. Os resultados são usados para determinar se o produto atende aos requisitos de consumo do OneRoster 1.2 do Google. Faça o download ou uma captura de tela do relatório gerado para compartilhar com seus contatos na equipe do Google Sala de Aula.

Obter um domínio de demonstração para desenvolvedores

Depois que os resultados do teste de conformidade forem analisados pela equipe do Google Sala de Aula, um domínio de demonstração para desenvolvedores vai permitir que você valide sua integração de ponta a ponta. A aprovação nos testes de conformidade não garante a aprovação da parceria ou da integração.

Um domínio de demonstração para desenvolvedores é um ambiente de teste ativo do Google Sala de Aula para ajudar você a validar se a integração está funcionando como esperado. Siga as etapas para receber um domínio de demonstração para desenvolvedores e solicitar um upgrade de domínio de demonstração. O upgrade provisiona seu domínio com 10 licenças do Google Workspace for Education Plus. Essas licenças precisam ser atribuídas aos usuários de teste no seu domínio de desenvolvedor para que eles possam testar os recursos de integração com o SIA no Google Sala de Aula.

Perguntas frequentes

1. Qual modelo de dados o Google Sala de Aula espera do SIA?

O Google Sala de Aula segue a especificação do OneRoster 1.2. Se o SIA usar uma estrutura de dados diferente, talvez você encontre um comportamento inesperado. Por exemplo, se o sistema for compatível com uma relação aninhada entre períodos de avaliação e categorias de notas, isso não se enquadra na especificação do OneRoster 1.2. Nesse caso, teste sua integração minuciosamente para garantir a compatibilidade adequada.

2. Quais notas e status de atividades são exportados para o SIA?

Somente as notas devolvidas ou as atividades marcadas como "ausente" ou "dispensada" são exportadas para o SIA. As notas temporárias não são exportadas.

3. O que acontece com o item de linha no SIA se uma atividade for excluída no Google Sala de Aula?

Excluir uma atividade no Google Sala de Aula não exclui o item de linha correspondente no SIA. Isso evita a perda acidental de dados e exclusões em cascata não intencionais.