Usar o Explorador do Graph para tentar Microsoft Graph APIs

  • Artigo

O Graph Explorer é uma ferramenta de programação para explorar as APIs do Microsoft Graph. Use-o para:

  • Teste as APIs num inquilino de exemplo e explore os recursos disponíveis.
  • Inicie sessão no seu próprio inquilino para criar protótipos de cenários de aplicações.
  • Saiba mais sobre as permissões necessárias para diferentes APIs.
  • Explore os componentes do Microsoft Graph Toolkit, cartões ajustáveis e fragmentos de código para consultas.

Para começar, aceda ao Graph Explorer no browser.

Explorar uma consulta de exemplo

Pode executar as consultas de exemplo pré-criadas para ver como funciona a API. Selecione qualquer consulta de exemplo, como Obter o meu perfil, para ver o pedido e a resposta.

Captura de ecrã da IU do Graph Explorer, que apresenta os resultados devolvidos da consulta OBTER o meu perfil.

Iniciar sessão para obter mais funcionalidades

Pode utilizar o Graph Explorer sem iniciar sessão. Os utilizadores que iniciam sessão podem aceder aos seus próprios inquilinos e realizar operações mais avançadas. Para experimentar pedidos POST, PUT, PATCH e DELETE, inicie sessão com a sua conta do Microsoft 365.

Recomendamos que inicie sessão no inquilino do sandbox do Microsoft 365 Developer em vez do inquilino de produção para evitar operações em execução que possam afetar os seus dados de produção.

Importante

Se optar por iniciar sessão com a sua conta organizacional, executar qualquer pedido de escrita no Graph Explorer poderá afetar os dados no inquilino.

Executar a primeira consulta

Para executar uma consulta no Graph Explorer:

  1. Selecione uma consulta de exemplo ou escreva a consulta no campo de pedido.
  2. Edite o corpo do pedido e os cabeçalhos do pedido conforme necessário para a consulta. Por exemplo, para executar um pedido Post, selecione POST na lista pendente do verbo HTTP e adicione um corpo do pedido e cabeçalhos de pedido conforme adequado.
  3. Selecione Executar consulta. A resposta é apresentada na secção Pré-visualização da resposta. Inclui o código de status HTTP e os dados devolvidos pela API.
  4. Junto ao separador Pré-visualização da resposta, também pode ver os cabeçalhos de resposta, os fragmentos de código, os componentes do Toolkit e os cartões ajustáveis que são relevantes para a consulta.

Captura de ecrã do Graph Explorer a executar uma consulta POST para criar uma nova aplicação.

Modificar permissões

Algumas consultas requerem permissões específicas. Se uma consulta falhar devido a permissões insuficientes, verá uma mensagem de erro. Para consentir as permissões:

  1. Selecione as permissões Modificar para consentir as permissões necessárias.
  2. Execute a consulta novamente.
  3. Também pode selecionar o avatar do perfil e selecionar Consentimento para permissões. Na lista de todas as permissões disponíveis, consenta as permissões pretendidas.

Captura de ecrã do separador Modificar permissões no Graph Explorer.

Localizar a API certa para a sua aplicação

Utilize o separador Recursos e a funcionalidade de documentação para encontrar a API certa para a sua aplicação.

Separador Recursos

Utilize o separador Recursos para procurar uma lista de recursos do Microsoft Graph nos pontos finais beta e v1.0 ou utilize a barra de pesquisa para procurar um recurso específico.

Também pode selecionar consultas específicas para adicionar à sua coleção. Quando terminar de adicionar recursos, selecione Pré-visualizar coleção. Na vista de coleção, pode rever, remover e transferir os recursos que selecionou.

À esquerda encontra-se uma captura de ecrã do separador Recursos no Graph Explorer. O lado direito apresenta o painel Pré-visualizar coleção.

Selecione Documentação em cada consulta para saber mais sobre o ponto final da API. A referência da API relevante fornece mais informações sobre os parâmetros do pedido, a estrutura de resposta e as permissões necessárias.

Integrar APIs do Microsoft Graph na sua aplicação

Utilize as seguintes funcionalidades no Graph Explorer para integrar as APIs do Microsoft Graph na sua aplicação.

Trechos de código

Depois de executar uma consulta, selecione o separador Fragmentos de código para ver como executar a mesma operação na sua linguagem preferida (C#, JavaScript, Java, Go, PowerShell).

Captura de ecrã do separador fragmentos de código no Graph Explorer.

Componente do Toolkit

O Microsoft Graph Toolkit fornece componentes Web reutilizáveis e agnósticos e auxiliares que têm fornecedores incorporados que se autenticam e obtêm dados do Microsoft Graph.

O componente toolkit no Graph Explorer permite-lhe visualizar componentes do Microsoft Graph Toolkit que correspondem às consultas da API. Um ponto azul no separador do componente do toolkit indica um componente disponível para a consulta da API REST atualmente especificada. Você pode copiar facilmente o código do componente em seu aplicativo.

Captura de ecrã do separador Toolkit do Microsoft Graph no Graph Explorer.

Cartões ajustáveis

Os cartões ajustáveis fornecem fragmentos agnósticos de plataforma da IU, criados em JSON, que as aplicações e os serviços podem trocar abertamente. Um ponto azul no separador cartões ajustáveis indica que está disponível uma card adaptável para a consulta selecionada.

Captura de ecrã do separador cartões ajustáveis no Graph Explorer com os detalhes da resposta realçados.

Mais funcionalidades do Graph Explorer

Para o ajudar a aproveitar ao máximo o Graph Explorer, familiarize-se com as seguintes funcionalidades adicionais da ferramenta.

Histórico

Selecione Histórico para aceder e exportar consultas executadas nos últimos 30 dias.

Captura de ecrã do separador histórico no Graph Explorer.

Configurações

Pode personalizar o Graph Explorer IU com o ícone de definições no canto superior direito. Também pode expandir, fechar ou redimensionar a barra lateral.

Compartilhar

Para partilhar a sua consulta atual, selecione Partilhar para que as pessoas possam experimentar a consulta específica no Graph Explorer.

Conteúdo relacionado