Introdução à API Web do Microsoft Dataverse
API Web ou serviço de organização
A API Web e o serviço de organização são as duas principais formas de interagir com dados e metadados no Microsoft Dataverse. Você pode usar o serviço de organização ao escrever plug-ins ou extensões de fluxo de trabalho usando o SDK para .NET fornecido pela Microsoft.
Não importa qual seja sua abordagem, todas as operações de dados passam pelo serviço da organização subjacente. Dessa forma, a API Web permite executar as mesmas operações que o serviço da organização, mas no estilo RESTful.
O gráfico a seguir é uma árvore de decisão que pode ajudar a determinar quando usar a API Web em vez do serviço de organização (por meio dos assemblies SDK disponíveis no pacote NuGet Microsoft.CrmSdk.CoreAssemblies). Ele também mostra quando usar os assemblies de ServiceClient do Dataverse (disponíveis no pacote Microsoft.PowerPlatform.Dataverse.Client NuGet) para aplicativos Windows.
Este módulo se concentra na API Web. Para obter mais informações sobre o serviço da organização, consulte Usar o serviço Dataverse Organization no Guia do Desenvolvedor do Dataverse.
Protocolo Open Data (OData) 4.0
A API Web do Dataverse é implementada como um serviço OData (OASIS — Protocolo Open Data). O uso de um padrão do setor como esse oferece todos os benefícios do desenvolvimento de padrões abertos, como compatibilidade entre plataformas e implementação simples em um protocolo comum e predefinido.
O Dataverse não oferece uma ferramenta do .NET específica para a API Web. Em vez disso, recomendamos que você use bibliotecas de comunidades que seguem o protocolo OData. Se você deseja mais informações sobre as bibliotecas existentes, consulte https://www.odata.org/libraries/.
O OData permite interagir com dados do Dataverse com operações CRUD (Criar, Ler, Atualizar, Excluir) que estão disponíveis por meio de métodos HTTP GET, POST, PATCH e DELETE padrão. (Você pode encontrar mais informações sobre esses métodos posteriormente neste módulo.) Você também pode executar praticamente qualquer outra operação exposta por meio da Estrutura de Eventos do Dataverse invocando uma função ou ação OData com o mesmo nome de sua mensagem de serviço de organização correspondente. As mensagens relacionadas ao CRUD são as únicas que não estão disponíveis, pois usam os métodos HTTP padrão descritos anteriormente.
REST
Fundamentalmente, o protocolo OData é um conjunto de APIs RESTful (Transferência de Estado Representacional), um padrão do setor para fornecer interoperabilidade entre sistemas. O REST envolve seis princípios de orientação que restringem a forma como um serviço pode processar e responder a solicitações para garantir que as propriedades não funcionais desse serviço sejam atendidas (como desempenho, escalabilidade, simplicidade, confiabilidade etc.).
Para esta lição, lembre-se de que o OData está em conformidade com essas restrições e que a API Web do Dataverse que implementa o protocolo OData também está em conformidade com as restrições.
FetchXML
FetchXML é uma linguagem de consulta robusta que permite consultas complexas de dados do Dataverse. Você pode usar FetchXML para compor seus critérios de consulta ao executar consultas com a API Web do Dataverse. Essa abordagem pode ser valiosa se você encontrar um cenário em que o FetchXML se ajuste melhor a sua consulta específica do que a sintaxe de consulta OData. Você pode encontrar mais informações sobre FetchXML em uma unidade posterior neste módulo.