Como trabalhar com APIs de educação no Microsoft Graph

  • Artigo

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

As APIs de educação no Microsoft Graph aprimoram recursos e dados do Microsoft 365 com informações relevantes para cenários educacionais, incluindo escolas, alunos, professores, aulas, matrículas e atribuições. Isso facilita a criação de soluções que se integram aos recursos educacionais.

As APIs de educação incluem recursos de listagem e atribuições que você pode usar para interagir com os serviços de listagem e atribuição no Microsoft Teams. Você pode usar esses recursos para gerenciar uma lista escolar e automatizar as atribuições dos alunos.

Autorização

Para chamar as APIs de educação no Microsoft Graph, o aplicativo precisará adquirir um token de acesso. Para obter detalhes sobre tokens de acesso, confira Obter tokens de acesso para chamar o Microsoft Graph. O aplicativo também precisará das permissões apropriadas. Para saber mais, confira Permissões de educação.

Para implantar os aplicativos que são integrados às APIs de educação do Microsoft Graph, primeiramente, os administradores de TI da escola devem dar consentimento para as permissões solicitadas pelo aplicativo. Esse consentimento deve ser concedido apenas uma vez, a menos que as permissões mudem. Após o consentimento do administrador, o aplicativo está provisionado para todos os usuários no locatário.

Para disparar uma caixa de diálogo de consentimento, use a chamada REST a seguir.

GET https://login.microsoftonline.com/{tenant}/adminconsent?
client_id={clientId}&state=12345&redirect_uri={redirectUrl}
Parâmetro Descrição
Tenant ID do locatário da escola. Use a ID completa, que inclui onmicrosoft.com.
clientId ID do cliente do aplicativo.
redirectUrl URL de redirecionamento do aplicativo.

Lista de participantes

As APIs de lista de participantes permitem extrair dados do locatário do Microsoft 365 de uma escola provisionado com o Microsoft School Data Sync. Essas APIs fornecem acesso às informações sobre escolas, seções, professores, alunos e listas de participantes. As APIs dão suporte a cenários somente aplicativo (sincronismo) e a cenários de aplicativo mais usuário (interativo). As APIs que dão suporte a cenários interativos aplicam políticas RBAC apropriadas da região, com base na função do usuário que está chamando a API. Isso fornece uma API consistente e uma superfície mínima de política, independentemente da configuração administrativa nos locatários. Além disso, as APIs também fornecem permissões específicas de educação, de modo a garantir que o usuário certo tenha acesso aos dados.

Você pode usar as APIs de escalação para permitir que um usuário do aplicativo saiba:

  • Quem eu sou
  • Quais aulas eu frequento ou ministro
  • O que preciso fazer e quando

As APIs de escalação fornecem os seguintes recursos-chave:

As APIs de escalação dão suporte aos seguintes cenários:

Atribuições

Você pode usar as APIs de educação relacionadas a atribuições para integrá-las às atribuições do Microsoft Teams. O Microsoft Teams no Microsoft 365 Educacional é baseado nas mesmas APIs educacionais e fornece um caso de uso para o que você pode fazer com as APIs. Seu aplicativo pode usar essas APIs para interagir com as tarefas em todo o ciclo de vida da tarefa.

As APIs de atribuição fornecem os seguintes recursos-chave:

  • educationAssignment - O objeto principal da API de atribuições. As atribuições são tarefas ou unidades de trabalho atribuídas a um aluno ou membro da equipe em uma classe como parte do estudo.
  • educationSubmission - Representa os recursos que um indivíduo (ou grupo) envia para uma tarefa, a nota associada e os comentários para essa tarefa.
  • educationResource - Representa o objeto de aprendizagem que está sendo atribuído ou enviado. Um educationResource está associado a um educationAssignment e/ou um educationSubmission.

As APIs de atribuição suportam os seguintes cenários:

A seguir estão alguns casos de uso comuns para as APIs educacionais relacionadas a atribuições.

Caso de uso Descrição Veja também
Criar tarefas Um sistema externo pode criar uma tarefa para a classe e anexar recursos à tarefa. Criar tarefa
Leia as informações da atribuição Um aplicativo de análise pode obter informações sobre tarefas e envios dos alunos, incluindo datas e notas. Obter a tarefa
Acompanhar os envios dos alunos Seu aplicativo pode fornecer um painel do professor que mostra quantos envios de alunos precisam ser avaliados. Recurso de submissão

Gerenciamento de sincronização de dados escolares

A Sincronização de Dados Escolares ajuda a automatizar o processo de importação e sincronização de dados de lista de dados de sistemas de informações do aluno com Microsoft Entra ID e Microsoft 365. Você pode usar as APIs de gerenciamento de sincronização de dados escolares no Microsoft Graph para configurar a sincronização de um arquivo CSV ou de um conector de API do SIS com suporte.

As APIs de gerenciamento de sincronização de dados escolares dão suporte aos seguintes cenários:

Próximas etapas

Use as APIs de educação do Microsoft Graph para criar soluções educacionais que acessam atribuições de alunos e listas escolares. Para saber mais:

  • Explore os recursos e os métodos mais úteis para seu cenário.
  • Experimente a API no Explorador do Graph.