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

Artigo
06/01/2021
5 minutos para o fim da leitura

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 de versão.

As APIs de educação no Microsoft Graph aprimoram os recursos e os dados do Microsoft 365 com informações relevantes para cenários educacionais, incluindo escolas, estudantes, professores, classes, registradoras 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 recursos de atribuições que você pode usar para interagir com os serviços de lista e atribuição no Microsoft Teams. Você pode usar esses recursos para gerenciar uma lista de escolas e automatizar as atribuições de aluno.

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 acionar 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:

educationSchool – representa a escola.
educationClass – representa uma aula em uma escola.
educationTerm – representa uma parte designada do ano acadêmico.
educationTeacher – representa um usuário com a função principal de ‘Professor’.
educationStudent – representa um usuário com a função principal de 'aluno'.

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

Atribuições

Você pode usar as APIs de educação relacionadas à atribuição para integrar com as atribuições no Microsoft Teams. O Microsoft Teams no Microsoft 365 for Education é baseado nas mesmas APIs de educação 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 atribuições ao longo do ciclo de vida da atribuição.

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

educationAssignment -o objeto principal da API assignments. Representa uma tarefa ou unidade de trabalho atribuída a um membro de aluno ou de equipe em uma classe como parte de seu estudo.
educationSubmission -representa os recursos que um indivíduo (ou grupo) envia para uma atribuição e a grade associada e o feedback da atribuição.
educationResource -representa o objeto de aprendizado que está sendo atribuído ou enviado. Um educationResource está associado a um educationAssignment e/ou um educationSubmission.

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

A seguir estão alguns casos de uso comuns para as APIs de educação relacionadas à atribuição.

Caso de uso	Descrição	Confira também
Criar atribuições	Um sistema externo pode criar uma atribuição para a classe e anexar recursos à atribuição.	Criar tarefa
Ler informações de atribuição	Um aplicativo de análise pode obter informações sobre atribuições e envios de alunos, incluindo datas e notas.	Obter tarefa
Acompanhar envios de alunos	Seu aplicativo pode fornecer um painel de professores que mostra quantos envios de alunos precisam ser compensados.	Recurso de envio

Gerenciamento escolar de sincronização de dados

O School Data Sync ajuda a automatizar o processo de importação e sincronização de dados de lista de sistemas de informações do aluno com o Active Directory do Azure (Azure AD) e o Microsoft 365. Você pode usar as APIs de gerenciamento de sincronização de dados da escola no Microsoft Graph para configurar a sincronização de um arquivo CSV ou de um conector de API SIS suportado.

As APIs de gerenciamento de sincronização de dados da escola oferecem suporte aos seguintes cenários:

O que há de novo

Saiba mais sobre os novos recursos e atualizações mais recentes para este conjunto de APIs.

Próximas etapas

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

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