Use o Postman com a API do Microsoft Graph

  • Artigo

Postman é uma plataforma de API para construir e usar APIs. O Postman simplifica cada etapa do ciclo de vida da API e agiliza a colaboração para que você possa criar APIs melhores com mais rapidez.

Você pode usar a coleção do Microsoft Graph Postman para começar a usar as APIs do Microsoft Graph em questão minutos.

Imagem do Postman

Este artigo explica como configurar a configuração inicial do seu ambiente para executar o Microsoft Graph no Postman. Para obter detalhes sobre como autenticar no Microsoft Graph via Postman, confira Usar autenticação delegada com o Postman para Microsoft Graph e Usar autenticação somente aplicativo com o Postman para Microsoft Graph. Você também pode explorar as APIs do Microsoft Graph diretamente em seu navegador da Web usando o Explorador do Graph.

Para obter detalhes sobre como usar o Postman, siga as etapas deste artigo ou watch o vídeo a seguir.

Dica

A coleção Do Microsoft Graph Postman está configurada para autenticar com o serviço de Microsoft Entra global e acessar o serviço global do Microsoft Graph (graph.microsoft.com). Se você quiser usar a coleção para se conectar a uma implantação de nuvem nacional, deverá modificar o bifurcação da coleção.

  • Atualize a URL de solicitação, substituindo pelo ponto de graph.microsoft.com extremidade raiz do serviço do Microsoft Graph para sua nuvem nacional.
  • Atualize os valores de URL de URL de Auth e Token de Acesso na guia Autorização das pastas Delegada e aplicativo , substituindo pelo ponto de login.microsoftonline.com extremidade para sua nuvem nacional.
  • Atualize o valor escopo na guia Autorização das pastas Delegada e aplicativo , substituindo graph.microsoft.com pelo ponto de extremidade raiz do serviço do Microsoft Graph para sua nuvem nacional.

Etapa 1: bifurcar a coleção Microsoft Graph Postman

Para usar a coleção do Postman, bifurque-a no próprio espaço de trabalho do Postman. Faça isso no navegador da Web.

  1. Vá para Postman e conecte-se.
  2. Vá para a coleção do Postman rotulada Microsoft Graph.
  3. Preencha um rótulo com sua própria bifurcação de repositório; pode ser qualquer texto.
  4. No espaço de trabalho, certifique-se de que Meu espaço de trabalho esteja selecionado na lista suspensa.
  5. Selecione Coleção de Bifurcações.

Você é redirecionado para uma bifurcação da coleção principal do Microsoft Graph Postman no próprio espaço de trabalho.

Etapa 2: baixe o Agente Postman (opcional - Somente navegador da Web Postman)

Para usar esta coleção específica do Postman em seu navegador, baixe o Agente de área de trabalho Postman. Não é possível usar o Postman para a Web sem isso devido às restrições de CORS do navegador.

Você não precisa do agente se estiver usando o aplicativo Postman para Windows. Se você abrir o Postman para Windows, verá essa coleção bifurcada em seu espaço de trabalho.

Etapa 3: Criar um aplicativo Microsoft Entra

Para usar essa coleção em seu próprio locatário de desenvolvedor, crie um aplicativo Microsoft Entra e forneça as permissões apropriadas para as solicitações que você deseja chamar. 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.

  1. Entre no Centro de administração do Microsoft Entra.
  2. Expanda o menu >Identidade selecione Aplicativos>Registros de aplicativo>Novo registro.
  3. Defina o Nome do aplicativo como Postman.
  4. No menu suspenso, selecione Web.
  5. Defina a URI de redirecionamento comohttps://oauth.pstmn.io/v1/browser-callback.
  6. Selecione Registrar.
  7. No menu à esquerda, selecione Permissões da API.
  8. No menu horizontal, selecione Adicionar uma permissão e escolha Microsoft Graph.
  9. Selecione a opção Permissões Delegadas , digite Mail., expanda as opções email e selecione Mail.Read.
  10. Selecione a opção Permissões de aplicativo , digite User., expanda as opções usuário e selecione User.Read.All.
  11. Selecione Adicionar permissões para adicionar as duas permissões das etapas anteriores.
  12. No menu horizontal, selecione Conceder consentimento de administrador para e, em seguida, selecione Sim.
  13. No menu à esquerda, selecione Visão geral. A partir daqui, você pode obter o ID do aplicativo (cliente) e o ID do diretório (locatário). Você precisará deles na etapa 4.
  14. No menu à esquerda, selecione Certificados e segredos.
  15. Selecione Novo segredo do cliente, insira uma descrição e selecione Adicionar. Passe o mouse sobre o novo Valor do segredo do cliente e copie-o; você precisará disso na etapa 4.

O aplicativo agora tem duas permissões configuradas. Mail.Read é adicionado como uma permissão delegada, que é uma permissão que requer um usuário conectado. O aplicativo pode ler emails em nome do usuário. User.Read.All é adicionado como uma permissão de aplicativo, que é uma permissão que não requer um usuário conectado. O aplicativo pode ler usuários no Microsoft Entra ID.

Etapa 4: Configurar autenticação

IMPORTANTE: Nas etapas a seguir, sempre defina valores na coluna "Valor atual", não na coluna "Valor inicial". Isso garante que seus segredos e tokens sejam salvos localmente em seu computador.

Nesta etapa, você configura as variáveis de ambiente no Postman que você usa para recuperar um token de acesso.

  1. Vá para o ambiente de Bifurcação.
  2. Adicionar um rótulo para a bifurcação. Pode ser qualquer texto.
  3. No espaço de trabalho, certifique-se de que Meu espaço de trabalho esteja selecionado na lista suspensa.
  4. Selecione Ambiente de Bifurcação.
  5. Em ClientID, defina o Valor atual como o valor da ID de aplicativo (cliente) da etapa 3.15.
  6. EmTenantID, defina o Valor atual como o valor da ID de diretório (locatário) da etapa 3.15.
  7. Em ClientSecret, defina o Valor atualpara o valor do segredo do cliente da etapa 3.17.
  8. No canto superior direito, selecione Salvar.
  9. Feche a guia Gerenciar ambientes.
  10. No canto superior direito, próximo ao ícone de olho, verifique se o Ambiente M365 está selecionado no menu suspenso e não em Nenhum ambiente.

Próximas etapas

Agora que você configurou com êxito o ambiente para executar o Microsoft Graph no Postman, continue com as etapas de autenticação:

Contribuindo para a coleção

Se você quiser contribuir com suas próprias solicitações para a coleção do Microsoft Graph Postman, precisará de uma licença do Postman. Você pode fazer alterações na coleção bifurcada e, em seguida, passar o mouse sobre o nó superior da coleção e selecionar Criar solicitação de pull.

Problemas conhecidos

Autenticação falhou com "Você não pode chegar lá a partir daqui"

Certas políticas de acesso condicional configuradas pelos administradores da sua organização podem bloquear o fluxo de autenticação do Postman. Para explorar alternativas, entre em contato com seus administradores.

"O acesso ao OData está desabilitado."

Consulte 403 Proibido "O acesso ao OData está desabilitado".

Conteúdo relacionado