Compartilhar via

Use a API Web do Microsoft Dataverse

Para trabalhar com dados, bem como definições de tabela e coluna no Dataverse, você pode usar a API Web ou o SDK para .NET.

A API Web do Dataverse fornece uma experiência de desenvolvimento que você pode usar em uma ampla variedade de linguagens de programação, plataformas e dispositivos. A API Web implementa o OData (Open Data Protocol), versão 4.0, um padrão OASIS para criar e consumir APIs RESTful em fontes de dados avançadas. Você pode saber mais sobre esse protocolo em https://www.odata.org/. Os detalhes sobre esse padrão OASIS estão disponíveis em https://www.oasis-open.org/standards#odatav4.0.

Como a API Web é criada em padrões abertos, além do SDK do Python, a Microsoft não fornece assemblies ou bibliotecas para uma experiência de desenvolvedor específica. Você pode compor solicitações HTTP para operações específicas ou usar bibliotecas de terceiros para gerar classes para qualquer linguagem ou plataforma desejada. Você pode encontrar uma lista de bibliotecas que dão suporte ao OData versão 4.0 em https://www.odata.org/libraries/.

Aplicativos controlados por modelos e Power Pages fornecem aos objetos métodos para executar operações de dados usando a API Web. Consulte:

API Web e o serviço de organização

É importante reconhecer que o serviço da organização é o que define a plataforma. A API Web fornece uma experiência de programação RESTful, mas, em última análise, todas as operações de dados passam pelo serviço de organização subjacente. O serviço da organização define as operações com suporte como mensagens. Cada mensagem tem um nome. Esses nomes são associados aos eventos usados na estrutura de eventos para avaliar quais extensões registradas devem ser iniciadas. Para obter mais informações, consulte a Estrutura de Eventos.

A API Web permite que você faça as mesmas operações que o SDK para .NET, mas as apresenta em um estilo RESTful. O OData v4 fornece operações nomeadas por meio de funções ou ações. A maioria das mensagens disponíveis no serviço da organização são expostas como uma função ou ação nomeada correspondente. As mensagens que correspondem às operações CRUD não estão disponíveis na API Web. Como um serviço RESTful, essas operações têm implementações que usam GET, POST, PATCH, e DELETE métodos HTTP. No entanto, dentro da plataforma, as mensagens de recuperação, criação, atualização e exclusão são invocadas da mesma forma que as operações correspondentes são executadas usando o SDK para assemblies .NET.

Como começar

Você pode usar a API Web com qualquer idioma que permita enviar solicitações HTTP autenticadas. Preparamos algumas experiências de introdução para quatro cenários comuns:

Ferramentas de solicitação HTTP

Um aplicativo que você pode usar para redigir e enviar solicitações HTTP autenticadas é uma ferramenta essencial. Muitas opções estão disponíveis, como Postman, Bruno ou curl. Escolha e use qualquer ferramenta que você mais goste. As etapas a seguir descrevem como usar a Insônia porque ela tem uma interface gráfica do usuário, uma instalação relativamente fácil e fornece uma opção para recusar a criação de uma conta. Saiba como usar a Insônia com a API Web do Dataverse.

Dica

A menos que você já tenha uma ferramenta de solicitação HTTP favorita, você pode descobrir que usar o PowerShell com o Visual Studio Code é tão fácil de começar e permite recursos de script avançados também.

Desenvolvedores do PowerShell

Usar a API Web com o PowerShell é uma das maneiras mais fáceis de começar. Você pode usar o cmdletInvoke-RestMethod para enviar solicitações e processar as respostas usando o cmdletConvertTo-Json.

Você pode encontrar o seguinte conteúdo sobre como usar o PowerShell com a API Web:

Desenvolvedores javaScript

Os desenvolvedores do JavaScript frequentemente usam a API Web do Dataverse com aplicativos controlados por modelos. Aplicativos controlados por modelos fornecem o objeto Xrm.WebApi que expõe métodos para interagir com a API Web. Saiba mais sobre o JavaScript do lado do cliente usando a API Web em aplicativos controlados por modelos.

Os SPAs (Aplicativos de Página Única) também usam JavaScript e podem se conectar à API Web do Dataverse. Início Rápido: a API Web com o JavaScript do lado do cliente e o Visual Studio Code descreve como se conectar à API Web usando um padrão de aplicativo SPA. Você pode encontrar mais exemplos em Exemplos de Operações de Dados da API Web (JavaScript do lado do cliente).

Dentro dos componentes do PCF (Power Apps Component Framework), os desenvolvedores do JavaScript usam métodos que fazem parte do objeto WebAPI para trabalhar com dados do Dataverse em componentes pcf.

Por fim, o Power Pages expõe uma API Web de portais que oferece um subconjunto de operações do Dataverse disponíveis usando a API Web.

Desenvolvedores .NET

Os desenvolvedores do .NET podem usar o SDK do Dataverse para .NET ou a API Web. Talvez você queira usar a API Web quando não quiser ter uma dependência de um pacote NuGet específico ou os requisitos do seu projeto não requererem as classes fortemente tipadas fornecidas pelo SDK para .NET.

Para usar a API Web com C#, consulte estes artigos de início rápido:

Para obter mais exemplos de API Web em C#, consulte Exemplos de operações de dados da API Web (C#).

Trabalhar com dados usando código
OData - a melhor forma de REST
OData Versão 4.0 Parte 1: Protocolo e Errata 02
OData Versão 4.0 Parte 2: Convenções de URL e Errata 02
OData versão 4.0 Parte 3: Common Schema Definition Language (CSDL) Plus Errata 02

  • Last updated on