Introducción a la API web de Microsoft Dataverse
API web frente al servicio de organización
La API Web y el servicio de organización son las dos formas principales de interactuar con los datos y metadatos en Microsoft Dataverse. Puede utilizar el servicio de organización cuando escriba complementos o extensiones de flujo de trabajo utilizando el SDK para .NET que proporciona Microsoft.
Independientemente del método, todas las operaciones de datos pasan por el servicio de organización subyacente. Como tal, la API web le permite realizar las mismas operaciones que el servicio de organización pero en un estilo RESTful.
El siguiente gráfico es un árbol de decisión que puede ayudarle a determinar cuándo utilizar la API web frente al servicio de organización (a través de los ensamblajes del SDK disponibles en el paquete Microsoft.CrmSdk.CoreAssemblies NuGet package). También muestra cuándo utilizar los ensamblados de ServiceClient de Dataverse (disponibles en el paquete NuGet Microsoft.PowerPlatform.Dataverse.Client) para aplicaciones Windows.
Este módulo se centra en la API web. Para obtener más información sobre el servicio de organización, consulte Usar el servicio de Dataverse Organization en el Manual para desarrolladores de Dataverse.
OData (Open Data Protocol) 4.0
La API web de Dataverse se implementa como un servicio OData (OASIS Open Data Protocol). Al utilizar un estándar del sector como este, se brindan todas las ventajas del desarrollo de estándares abiertos, como la compatibilidad multiplataforma y la implementación simple con un protocolo común predefinido.
Dataverse no proporciona herramientas de .NET específicas para la API web. En su lugar, le recomendamos que use bibliotecas de la comunidad que cumplan el protocolo OData. Si desea obtener más información sobre las bibliotecas que existen, consulte https://www.odata.org/libraries/.
OData le permite interactuar con datos de Dataverse con operaciones de creación, lectura, actualización, eliminación (CRUD) que están disponibles a través de los métodos estándar GET, POST, PATCH y DELETE HTTP. (Puede encontrar más información sobre estos métodos más adelante en este módulo). También puede realizar casi cualquier otra operación ofrecida a través de Dataverse Marco de trabajo de eventos invocando una función o una acción de OData que tenga el mismo nombre que el mensaje correspondiente del servicio de organización. Los mensajes relacionados con CRUD son los únicos que no están disponibles, porque esos mensajes se utilizan los métodos HTTP estándar descritos anteriormente.
REST
Básicamente, el protocolo OData es un conjunto de API RESTful (Transferencia de estado representacional), un estándar del sector para proporcionar interoperabilidad entre sistemas. REST consta de seis principios rectores que restringen la forma en que un servicio puede procesar y responder a las solicitudes para garantizar que se cumplan las propiedades no funcionales de ese servicio (como rendimiento, escalabilidad, simplicidad, confiabilidad, etc.).
Para esta lección, debe tener en cuenta que OData cumple con estas restricciones y que la API web de Dataverse que implementa el protocolo OData también se ajusta a las restricciones.
FetchXML
FetchXML es un eficaz lenguaje de consulta que permite realizar consultas complejas de datos de Dataverse. Puede utilizar FetchXML para redactar sus criterios de consulta cuando ejecuta consultas con la API web de Dataverse. Este enfoque puede resultar útil si encuentra en una situación en la que FetchXML es más adecuado para una consulta concreta que el uso de la sintaxis de consulta OData. Puede encontrar más información sobre FetchXML más adelante en este módulo.