Desenvolvimento com as APIs REST para o Power BI Report Server

O Power BI Report Server suporta APIs de Transferência de Estado Representacional (REST). As APIs REST são endpoints de serviço que suportam um conjunto de operações HTTP (métodos), que fornecem acesso para criar, recuperar, atualizar ou eliminar recursos dentro de um servidor de relatórios.

A API REST fornece acesso programático aos objetos num catálogo do Power BI Report Server. Exemplos de objetos são pastas, relatórios, KPIs, fontes de dados, conjuntos de dados, planos de atualização, subscrições e muito mais. Usando a API REST, pode, por exemplo, navegar pela hierarquia de pastas, descobrir o conteúdo de uma pasta ou descarregar uma definição de relatório. Também pode criar, atualizar e eliminar objetos. Exemplos de trabalhar com objetos são carregar um relatório, executar um plano de atualização, eliminar uma pasta, e assim por diante.

Componentes de um pedido/resposta a uma API REST

Um par de pedido/resposta da API REST pode ser separado em cinco componentes:

• O URI de requisição, que consiste em: {URI-scheme} :// {URI-host} / {resource-path} ? {query-string}. Embora o URI do pedido esteja incluído no cabeçalho da mensagem de pedido, aqui chamamo-lo separadamente porque a maioria das linguagens ou frameworks exige que o passe separadamente da mensagem de pedido.

  • Esquema URI: Indica o protocolo usado para transmitir o pedido. Por exemplo, http ou https.
  • Host URI: Especifica o nome de domínio ou endereço IP do servidor onde o endpoint do serviço REST está alojado, como myserver.contoso.com.
  • Caminho de recursos: Especifica o recurso ou coleção de recursos, que pode incluir múltiplos segmentos usados pelo serviço para determinar a seleção desses recursos. Por exemplo: CatalogItems(01234567-89ab-cdef-0123-456789abcdef)/Properties pode ser usado para obter as propriedades especificadas para o CatalogItem.
  • Cadeia de consulta (opcional): Fornece outros parâmetros simples, como a versão da API ou critérios de seleção de recursos.

• Campos do cabeçalho da mensagem de pedido HTTP:

  • Um método HTTP obrigatório (também conhecido como operação ou verbo), que indica ao serviço que tipo de operação está a pedir. As APIs REST dos Serviços de Relatórios suportam métodos DELETE, GET, HEAD, PUT, POST e PATCH.
  • Outros campos de cabeçalho opcionais, conforme exigido pelo URI e método HTTP especificados.

• Campos opcionais do corpo da mensagem de pedido HTTP, para dar suporte à operação HTTP e ao URI. Por exemplo, as operações POST contêm objetos codificados MIME que são passados como parâmetros complexos. Para operações POST ou PUT, o tipo de codificação MIME para o corpo deve também ser especificado no cabeçalho do Content-type pedido. Alguns serviços exigem que utilize um tipo específico de MIME, como application/json.

• Campos de cabeçalho da mensagem de resposta HTTP:

  • Um código de estado HTTP, que vai desde códigos de sucesso 2xx até códigos de erro 4xx ou 5xx. Em alternativa, pode ser devolvido um código de estado definido pelo serviço, conforme indicado na documentação da API.
  • Outros campos de cabeçalho opcionais, conforme necessário para suportar a resposta do pedido, como um Content-type cabeçalho de resposta.

• Campos opcionais do corpo da mensagem de resposta HTTP:

  • Os objetos de resposta codificados MIME são devolvidos no corpo da resposta HTTP, como uma resposta de um método GET que está a devolver dados. Normalmente, estes objetos são devolvidos num formato estruturado como JSON ou XML, conforme indicado pelo Content-type cabeçalho de resposta.

Documentação da API

Uma API REST moderna exige documentação moderna da API. A API REST baseia-se na especificação OpenAPI (também conhecida como especificação swagger) e a documentação está disponível no Microsoft Learn.

Testar chamadas API

Uma ferramenta para testar mensagens de pedido/resposta HTTP é o Fiddler. O Fiddler é um proxy gratuito de depuração web que pode intercetar os seus pedidos REST, facilitando o diagnóstico das mensagens de pedido/resposta HTTP.

Conteúdo relacionado

Consulte as APIs disponíveis no Microsoft Learn.

Exemplos estão disponíveis no GitHub. O exemplo inclui uma aplicação HTML5 construída sobre TypeScript, React e webpack, juntamente com um exemplo em PowerShell.

Mais perguntas? Tente perguntar à Comunidade do Power BI