Criar aplicativos Python com o Microsoft Graph
Este tutorial ensina como criar um aplicativo de console do Python que usa o microsoft API do Graph para acessar dados em nome de um usuário.
Observação
Para saber como usar o Microsoft Graph para acessar dados usando autenticação somente aplicativo, confira este tutorial de autenticação somente aplicativo.
Neste tutorial, você vai:
Dica
Como alternativa a seguir este tutorial, você pode baixar o código concluído por meio da ferramenta de início rápido , que automatiza o registro e a configuração do aplicativo. O código baixado funciona sem nenhuma modificação necessária.
Você também pode baixar ou clonar o repositório GitHub e seguir as instruções no README para registrar um aplicativo e configurar o projeto.
Pré-requisitos
Antes de iniciar este tutorial, você deve ter Python e pip instalados em seu computador de desenvolvimento.
Você também deve ter uma conta de trabalho ou de estudante da Microsoft com uma caixa de correio Exchange Online. Se você não tiver um locatário do Microsoft 365, poderá se qualificar para um por meio do Programa de Desenvolvedores do Microsoft 365; para obter detalhes, confira as perguntas frequentes. Como alternativa, você pode se inscrever para uma avaliação gratuita de 1 mês ou comprar um plano do Microsoft 365.
Observação
Este tutorial foi escrito com Python versão 3.10.4 e pip versão 20.0.2. As etapas neste guia podem funcionar com outras versões, mas isso não foi testado.
Registrar o aplicativo no portal
Neste exercício, você registrará um novo aplicativo no Azure Active Directory para habilitar a autenticação do usuário. Você pode registrar um aplicativo usando o centro de administração do Azure Active Directory ou usando o SDK do Microsoft Graph PowerShell.
Registrar aplicativo para autenticação de usuário
Nesta seção, você registrará um aplicativo que dá suporte à autenticação do usuário usando o fluxo de código do dispositivo.
Abra um navegador e navegue até o centro de administração do Azure Active Directory e faça logon usando uma conta de trabalho ou de estudante.
Selecione Azure Active Directory na navegação esquerda e selecione Registros de aplicativos em Gerenciar.
Selecione Novo registro. Insira um nome para seu aplicativo, por exemplo,
Graph User Auth Tutorial
.Defina tipos de conta com suporte conforme desejado. As opções são:
Opção Quem pode entrar? Contas apenas neste diretório organizacional Somente usuários em sua organização do Microsoft 365 Contas em qualquer diretório organizacional Usuários em qualquer organização do Microsoft 365 (contas corporativas ou escolares) Contas em qualquer diretório organizacional... e contas pessoais da Microsoft Usuários em qualquer organização do Microsoft 365 (contas corporativas ou escolares) e contas pessoais da Microsoft Deixe o URI de Redirecionamento vazio.
Selecione Registrar. Na página Visão geral do aplicativo, copie o valor da ID do aplicativo (cliente) e salve-o, você precisará dele na próxima etapa. Se você escolheu Contas neste diretório organizacional apenas para tipos de conta com suporte, copie também a ID do Diretório (locatário) e salve-a.
Selecione Autenticação em Gerenciar. Localize a seção Configurações avançadas e altere a alternância Permitir fluxos de cliente público para Sim e escolha Salvar.
Observação
Observe que você não configurou nenhuma permissão do Microsoft Graph no registro do aplicativo. Isso ocorre porque o exemplo usa o consentimento dinâmico para solicitar permissões específicas para autenticação do usuário.
Criar um aplicativo de console do Python
Comece criando um novo arquivo Python.
Crie um novo arquivo chamado main.py e adicione o código a seguir.
print ('Hello world!')
Salve o arquivo e use o comando a seguir para executar o arquivo.
python3 main.py
Se funcionar, o aplicativo deverá gerar
Hello world!
.
Instalar dependências
Antes de seguir em frente, adicione algumas dependências adicionais que você usará posteriormente.
- Biblioteca de clientes do Azure Identity para Python para autenticar o usuário e adquirir tokens de acesso.
- SDK do Microsoft Graph para Python (versão prévia) para fazer chamadas para o Microsoft Graph.
Execute os comandos a seguir na CLI para instalar as dependências.
python3 -m pip install azure-identity
python3 -m pip install msgraph-sdk
Carregar configurações do aplicativo
Nesta seção, você adicionará os detalhes do registro do aplicativo ao projeto.
Crie um arquivo no mesmo diretório que main.py chamado config.cfg e adicione o código a seguir.
[azure] clientId = YOUR_CLIENT_ID_HERE tenantId = common graphUserScopes = User.Read Mail.Read Mail.Send
Atualize os valores de acordo com a tabela a seguir.
Configuração Valor clientId
A ID do cliente do registro do aplicativo tenantId
Se você escolheu a opção para permitir apenas que usuários em sua organização entrem, altere esse valor para sua ID de locatário. Caso contrário, deixe como common
.Dica
Opcionalmente, você pode definir esses valores em um arquivo separado chamado config.dev.cfg.
Design do aplicativo
Nesta seção, você criará um menu simples baseado em console.
Crie um novo arquivo chamado graph.py e adicione o código a seguir a esse arquivo.
# Temporary placeholder class Graph: def __init__(self, config): self.settings = config
Esse código é um espaço reservado. Você implementará a
Graph
classe na próxima seção.Abra main.py e substitua todo o conteúdo pelo código a seguir.
import asyncio import configparser from msgraph.generated.models.o_data_errors.o_data_error import ODataError from graph import Graph async def main(): print('Python Graph Tutorial\n') # Load settings config = configparser.ConfigParser() config.read(['config.cfg', 'config.dev.cfg']) azure_settings = config['azure'] graph: Graph = Graph(azure_settings) await greet_user(graph) choice = -1 while choice != 0: print('Please choose one of the following options:') print('0. Exit') print('1. Display access token') print('2. List my inbox') print('3. Send mail') print('4. Make a Graph call') try: choice = int(input()) except ValueError: choice = -1 try: if choice == 0: print('Goodbye...') elif choice == 1: await display_access_token(graph) elif choice == 2: await list_inbox(graph) elif choice == 3: await send_mail(graph) elif choice == 4: await make_graph_call(graph) else: print('Invalid choice!\n') except ODataError as odata_error: print('Error:') if odata_error.error: print(odata_error.error.code, odata_error.error.message)
Adicione os seguintes métodos de espaço reservado no final do arquivo. Você os implementará em etapas posteriores.
async def greet_user(graph: Graph): # TODO return async def display_access_token(graph: Graph): # TODO return async def list_inbox(graph: Graph): # TODO return async def send_mail(graph: Graph): # TODO return async def make_graph_call(graph: Graph): # TODO return
Adicione a linha a seguir para chamar
main
no final do arquivo.# Run main asyncio.run(main())
Isso implementa um menu básico e lê a escolha do usuário na linha de comando.
Adicionar autenticação de usuário
Nesta seção, você estenderá o aplicativo do exercício anterior para dar suporte à autenticação com Azure AD. Isso é necessário para obter o token de acesso OAuth necessário para chamar o Microsoft Graph. Nesta etapa, você integrará a biblioteca de clientes do Azure Identity para Python ao aplicativo e configurará a autenticação para o SDK do Microsoft Graph para Python (versão prévia).
A biblioteca de Identidade do Azure fornece várias classes que implementam fluxos de TokenCredential
token OAuth2. O SDK do Microsoft Graph usa essas classes para autenticar chamadas para o Microsoft Graph.
Configurar o cliente graph para autenticação de usuário
Nesta seção, você usará a DeviceCodeCredential
classe para solicitar um token de acesso usando o fluxo de código do dispositivo.
Abra graph.py e substitua todo o conteúdo pelo código a seguir.
from configparser import SectionProxy from azure.identity import DeviceCodeCredential from msgraph import GraphServiceClient from msgraph.generated.users.item.user_item_request_builder import UserItemRequestBuilder from msgraph.generated.users.item.mail_folders.item.messages.messages_request_builder import ( MessagesRequestBuilder) from msgraph.generated.users.item.send_mail.send_mail_post_request_body import ( SendMailPostRequestBody) from msgraph.generated.models.message import Message from msgraph.generated.models.item_body import ItemBody from msgraph.generated.models.body_type import BodyType from msgraph.generated.models.recipient import Recipient from msgraph.generated.models.email_address import EmailAddress class Graph: settings: SectionProxy device_code_credential: DeviceCodeCredential user_client: GraphServiceClient def __init__(self, config: SectionProxy): self.settings = config client_id = self.settings['clientId'] tenant_id = self.settings['tenantId'] graph_scopes = self.settings['graphUserScopes'].split(' ') self.device_code_credential = DeviceCodeCredential(client_id, tenant_id = tenant_id) self.user_client = GraphServiceClient(self.device_code_credential, graph_scopes)
Esse código declara duas propriedades privadas, um
DeviceCodeCredential
objeto e umGraphServiceClient
objeto. A__init__
função cria uma nova instância deDeviceCodeCredential
, em seguida, usa essa instância para criar uma nova instância deGraphServiceClient
. Sempre que uma chamada de API for feita ao Microsoft Graph por meio douser_client
, ela usará a credencial fornecida para obter um token de acesso.Adicione a função a seguir ao graph.py.
async def get_user_token(self): graph_scopes = self.settings['graphUserScopes'] access_token = self.device_code_credential.get_token(graph_scopes) return access_token.token
Substitua a função vazia
display_access_token
no main.py pelo seguinte.async def display_access_token(graph: Graph): token = await graph.get_user_token() print('User token:', token, '\n')
Crie e execute o aplicativo. Insira
1
quando solicitado para uma opção. O aplicativo exibe uma URL e um código de dispositivo.Python Graph Tutorial Please choose one of the following options: 0. Exit 1. Display access token 2. List my inbox 3. Send mail 4. Make a Graph call 1 To sign in, use a web browser to open the page https://microsoft.com/devicelogin and enter the code RB2RUD56D to authenticate.
Abra um navegador e navegue até a URL exibida. Insira o código fornecido e entre.
Importante
Fique atento a todas as contas existentes do Microsoft 365 que são registradas no navegador ao navegar para
https://microsoft.com/devicelogin
. Use recursos do navegador, como perfis, modo convidado ou modo privado para garantir que você se autentique como a conta que pretende usar para teste.Depois de concluído, retorne ao aplicativo para ver o token de acesso.
Dica
Somente para fins de validação e depuração, você pode decodificar tokens de acesso do usuário (somente para contas corporativas ou escolares) usando o analisador de token online da Microsoft em https://jwt.ms. Isso pode ser útil se você encontrar erros de token ao chamar o Microsoft Graph. Por exemplo, verificar se a
scp
declaração no token contém os escopos de permissão esperados do Microsoft Graph.
Obter usuário
Nesta seção, você incorporará o Microsoft Graph ao aplicativo. Para este aplicativo, você usará o SDK do Microsoft Graph para Python (versão prévia) para fazer chamadas para o Microsoft Graph.
Adicione a função a seguir ao graph.py.
async def get_user(self): # Only request specific properties using $select query_params = UserItemRequestBuilder.UserItemRequestBuilderGetQueryParameters( select=['displayName', 'mail', 'userPrincipalName'] ) request_config = UserItemRequestBuilder.UserItemRequestBuilderGetRequestConfiguration( query_parameters=query_params ) user = await self.user_client.me.get(request_configuration=request_config) return user
Substitua a função vazia
greet_user
no main.py pelo seguinte.async def greet_user(graph: Graph): user = await graph.get_user() if user: print('Hello,', user.display_name) # For Work/school accounts, email is in mail property # Personal accounts, email is in userPrincipalName print('Email:', user.mail or user.user_principal_name, '\n')
Se você executar o aplicativo agora, depois de fazer logon no aplicativo, receberá você pelo nome.
Hello, Megan Bowen!
Email: MeganB@contoso.com
Código explicado
Considere o código na get_user
função. São apenas algumas linhas, mas há alguns detalhes importantes a serem notados.
Acessando 'me'
A função cria uma solicitação para a API Obter usuário . Essa API está acessível de duas maneiras:
GET /me
GET /users/{user-id}
Nesse caso, o código chamará o ponto de extremidade da GET /me
API. Este é um método de atalho para obter o usuário autenticado sem saber a ID do usuário.
Observação
Como o ponto de extremidade da GET /me
API obtém o usuário autenticado, ele só está disponível para aplicativos que usam a autenticação do usuário. Aplicativos de autenticação somente aplicativo não podem acessar esse ponto de extremidade.
Solicitando propriedades específicas
A função usa o parâmetro de consulta $select para especificar o conjunto de propriedades de que precisa. O Microsoft Graph retornará apenas as propriedades solicitadas na resposta. No get_user
, isso é feito com o select
parâmetro no MeRequestBuilderGetQueryParameters
objeto.
Caixa de entrada listar
Nesta seção, você adicionará a capacidade de listar mensagens na caixa de entrada de email do usuário.
Adicione a função a seguir ao graph.py.
async def get_inbox(self): query_params = MessagesRequestBuilder.MessagesRequestBuilderGetQueryParameters( # Only request specific properties select=['from', 'isRead', 'receivedDateTime', 'subject'], # Get at most 25 results top=25, # Sort by received time, newest first orderby=['receivedDateTime DESC'] ) request_config = MessagesRequestBuilder.MessagesRequestBuilderGetRequestConfiguration( query_parameters= query_params ) messages = await self.user_client.me.mail_folders.by_mail_folder_id('inbox').messages.get( request_configuration=request_config) return messages
Substitua a função vazia
list_inbox
no main.py pelo seguinte.async def list_inbox(graph: Graph): message_page = await graph.get_inbox() if message_page and message_page.value: # Output each message's details for message in message_page.value: print('Message:', message.subject) if ( message.from_ and message.from_.email_address ): print(' From:', message.from_.email_address.name or 'NONE') else: print(' From: NONE') print(' Status:', 'Read' if message.is_read else 'Unread') print(' Received:', message.received_date_time) # If @odata.nextLink is present more_available = message_page.odata_next_link is not None print('\nMore messages available?', more_available, '\n')
Execute o aplicativo, entre e escolha a opção 2 para listar sua caixa de entrada.
Please choose one of the following options: 0. Exit 1. Display access token 2. List my inbox 3. Send mail 4. Make a Graph call 2 Message: Updates from Ask HR and other communities From: Contoso Demo on Yammer Status: Read Received: 2022-04-26T19:19:05Z Message: Employee Initiative Thoughts From: Patti Fernandez Status: Read Received: 2022-04-25T19:43:57Z Message: Voice Mail (11 seconds) From: Alex Wilber Status: Unread Received: 2022-04-22T19:43:23Z Message: Our Spring Blog Update From: Alex Wilber Status: Unread Received: 2022-04-19T22:19:02Z Message: Atlanta Flight Reservation From: Alex Wilber Status: Unread Received: 2022-04-19T15:15:56Z Message: Atlanta Trip Itinerary - down time From: Alex Wilber Status: Unread Received: 2022-04-18T14:24:16Z ... More messages available? True
Código explicado
Considere o código na get_inbox
função.
Acessando pastas de email bem conhecidas
A função cria uma solicitação para a API de Mensagens de Lista . Como inclui o mail_folders.by_mail_folder_id('inbox')
construtor de solicitações, a API só retornará mensagens na pasta de email solicitada. Nesse caso, como a caixa de entrada é uma pasta padrão e conhecida dentro da caixa de correio de um usuário, ela é acessível por meio de seu nome conhecido. As pastas não padrão são acessadas da mesma maneira, substituindo o nome conhecido pela propriedade ID da pasta de email. Para obter detalhes sobre os nomes de pastas conhecidos disponíveis, consulte o tipo de recurso mailFolder.
Acessando uma coleção
Ao contrário da get_user
função da seção anterior, que retorna um único objeto, esse método retorna uma coleção de mensagens. A maioria das APIs no Microsoft Graph que retornam uma coleção não retorna todos os resultados disponíveis em uma única resposta. Em vez disso, eles usam paginação para retornar uma parte dos resultados, fornecendo um método para os clientes solicitarem a próxima "página".
Tamanhos de página padrão
APIs que usam paginação implementam um tamanho de página padrão. Para mensagens, o valor padrão é 10. Os clientes podem solicitar mais (ou menos) usando o parâmetro de consulta $top . No get_inbox
, isso é feito com o top
parâmetro no MessagesRequestBuilderGetQueryParameters
objeto.
Observação
O valor passado é $top
um limite superior, não um número explícito. A API retorna várias mensagens até o valor especificado.
Obtendo páginas subsequentes
Se houver mais resultados disponíveis no servidor, as respostas de coleção incluirão uma @odata.nextLink
propriedade com uma URL de API para acessar a próxima página. O SDK do Python expõe isso como a odata_next_link
propriedade em objetos de página de coleção. Se essa propriedade estiver presente, haverá mais resultados disponíveis.
Classificando coleções
A função usa o parâmetro de consulta $orderby para solicitar resultados classificados no momento em que a mensagem é recebida (receivedDateTime
propriedade). Ele inclui o palavra-chave para que as DESC
mensagens recebidas mais recentemente sejam listadas primeiro. No get_inbox
, isso é feito com o orderby
parâmetro no MessagesRequestBuilderGetQueryParameters
objeto.
Enviar email
Nesta seção, você adicionará a capacidade de enviar uma mensagem de email como o usuário autenticado.
Adicione a função a seguir ao graph.py.
async def send_mail(self, subject: str, body: str, recipient: str): message = Message() message.subject = subject message.body = ItemBody() message.body.content_type = BodyType.Text message.body.content = body to_recipient = Recipient() to_recipient.email_address = EmailAddress() to_recipient.email_address.address = recipient message.to_recipients = [] message.to_recipients.append(to_recipient) request_body = SendMailPostRequestBody() request_body.message = message await self.user_client.me.send_mail.post(body=request_body)
Substitua a função vazia
send_mail
no main.py pelo seguinte.async def send_mail(graph: Graph): # Send mail to the signed-in user # Get the user for their email address user = await graph.get_user() if user: user_email = user.mail or user.user_principal_name await graph.send_mail('Testing Microsoft Graph', 'Hello world!', user_email or '') print('Mail sent.\n')
Execute o aplicativo, entre e escolha a opção 3 para enviar um email para si mesmo.
Please choose one of the following options: 0. Exit 1. Display access token 2. List my inbox 3. Send mail 4. Make a Graph call 3 Mail sent.
Observação
Se você estiver testando com um locatário do desenvolvedor do Microsoft 365 Developer Program, o email enviado talvez não seja entregue e você poderá receber um relatório de não entrega. Se isso acontecer com você, entre em contato com o suporte por meio do Centro de administração do Microsoft 365.
Para verificar se a mensagem foi recebida, escolha a opção 2 para listar sua caixa de entrada.
Código explicado
Considere o código na send_mail
função.
Enviar email
A função usa o user_client.me.send_mail
construtor de solicitações, que cria uma solicitação para a API enviar email .
Criando objetos
Ao contrário das chamadas anteriores para o Microsoft Graph que só leem dados, essa chamada cria dados. Para fazer isso com a biblioteca de clientes, você cria um dicionário que representa o conteúdo da solicitação, defina as propriedades desejadas e envie-a na chamada de API. Como a chamada está enviando dados, o post
método é usado em vez de get
.
Opcional: adicionar seu próprio código
Nesta seção, você adicionará seus próprios recursos do Microsoft Graph ao aplicativo. Isso pode ser um snippet de código da documentação do Microsoft Graph ou do Graph Explorer ou código que você criou. Esta seção é opcional.
Atualizar o aplicativo
Adicione a função a seguir ao graph.py.
async def make_graph_call(self): # INSERT YOUR CODE HERE return
Substitua a função vazia
make_graph_call
no main.py pelo seguinte.async def make_graph_call(graph: Graph): await graph.make_graph_call()
Escolher uma API
Encontre uma API no Microsoft Graph que você gostaria de experimentar. Por exemplo, a API criar eventos . Você pode usar um dos exemplos na documentação da API ou criar sua própria solicitação de API.
Configurar as permissões
Verifique a seção Permissões da documentação de referência da API escolhida para ver quais métodos de autenticação têm suporte. Algumas APIs não dão suporte somente a aplicativos ou contas pessoais da Microsoft, por exemplo.
- Para chamar uma API com autenticação de usuário (se a API dá suporte à autenticação de usuário (delegado), adicione o escopo de permissão necessário em config.cfg.
- Para chamar uma API com autenticação somente aplicativo, consulte o tutorial de autenticação somente aplicativo .
Adicionar seu código
Copie seu código na make_graph_call
função em graph.py. Se você estiver copiando um snippet da documentação ou do Graph Explorer, renomeie o GraphServiceClient
para self.user_client
.
Parabéns!
Você concluiu o tutorial do Python Microsoft Graph. Agora que você tem um aplicativo de trabalho que chama Microsoft Graph, você pode experimentar e adicionar novos recursos.
- Saiba como usar a autenticação somente aplicativo com o SDK do Microsoft Graph para Python.
- Visite a visão geral do Microsoft Graph para ver todos os dados que você pode acessar com o Microsoft Graph.
Exemplos de Python
Tem algum problema com essa seção? Se tiver, envie seus comentários para que possamos melhorar esta seção.