Desenvolver com as APIs REST para o Servidor de Relatórios do Power BI

O Servidor de Relatório do Power BI suporta APIs REST (Representational State Transfer). As APIs REST são pontos de extremidade de serviço que oferecem suporte a um conjunto de operações HTTP (métodos), que fornecem acesso de criação, recuperação, atualização ou exclusão para recursos em um servidor de relatório.

A API REST fornece acesso programático aos objetos em um catálogo do Servidor de Relatório do Power BI. Exemplos de objetos são pastas, relatórios, KPIs, fontes de dados, conjuntos de dados, planos de atualização, assinaturas e muito mais. Usando a API REST, você pode, por exemplo, navegar na hierarquia de pastas, descobrir o conteúdo de uma pasta ou baixar uma definição de relatório. Você também pode criar, atualizar e excluir objetos. Exemplos de trabalho com objetos são carregar um relatório, executar um plano de atualização, excluir uma pasta e assim por diante.

Nota

Se estiver interessado em visualizar ou eliminar dados pessoais, consulte as orientações da Microsoft no site Pedidos de Titulares de Dados do Windows para o RGPD . Se estiver à procura de informações gerais sobre o RGPD, consulte a secção RGPD do portal Service Trust.

Componentes de uma solicitação/resposta da API REST

Um par de solicitação/resposta da API REST pode ser separado em cinco componentes:

• O URI de solicitação, que consiste em: {URI-scheme} :// {URI-host} / {resource-path} ? {query-string}. Embora o URI de solicitação esteja incluído no cabeçalho da mensagem de solicitação, nós o chamamos separadamente aqui porque a maioria dos idiomas ou estruturas exigem que você o passe separadamente da mensagem de solicitação.

  • Esquema de URI: indica o protocolo usado para transmitir a solicitação. Por exemplo, http ou https.
  • Host URI: Especifica o nome de domínio ou endereço IP do servidor onde o ponto de extremidade do serviço REST está hospedado, como myserver.contoso.com.
  • Caminho do recurso: especifica o recurso ou a coleção de recursos, que pode incluir vários 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.
  • Seqüência de caracteres de consulta (opcional): fornece parâmetros simples adicionais, como a versão da API ou os critérios de seleção de recursos.

• Campos de cabeçalho da mensagem de solicitação HTTP:

  • Um método HTTP necessário (também conhecido como uma operação ou verbo), que informa ao serviço que tipo de operação você está solicitando. As APIs REST do Reporting Services oferecem suporte aos métodos DELETE, GET, HEAD, PUT, POST e PATCH.
  • Campos de cabeçalho adicionais opcionais, conforme exigido pelo método URI e HTTP especificado.

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

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

  • Um código de status HTTP, variando de códigos de sucesso 2xx a códigos de erro 4xx ou 5xx. Como alternativa, um código de status definido pelo serviço pode ser retornado, conforme indicado na documentação da API.
  • Campos de cabeçalho adicionais opcionais, conforme necessário para dar suporte à resposta da solicitação, como um cabeçalho de Content-type resposta.

• Campos opcionais do corpo da mensagem de resposta HTTP:

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

Documentação da API

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

Testando chamadas de API

Uma ferramenta para testar mensagens de solicitação/resposta HTTP é o Fiddler. O Fiddler é um proxy de depuração da Web gratuito que pode intercetar suas solicitações REST, facilitando o diagnóstico das mensagens de solicitação/resposta HTTP.

Conteúdos relacionados

Analise as APIs disponíveis no Microsoft Learn.

As amostras estão disponíveis no GitHub. O exemplo inclui um aplicativo HTML5 criado em TypeScript, React e webpack, juntamente com um exemplo do PowerShell.

Tem dúvidas? Tente perguntar à Comunidade do Power BI