Compartir a través de

Use la API web de Microsoft Dataverse

Puede utilizar la Web API o SDK para .NET para trabajar con datos, así como definiciones de tablas y columnas en Dataverse.

La API web de Dataverse proporciona una experiencia de desarrollo que puede usarse en una gran variedad de lenguajes de programación, plataformas, y dispositivos. La API web implementa OData (Open Data Protocol), versión 4.0, un estándar de OASIS para crear y consumir API RESTful con orígenes de datos enriquecidos. Puede obtener más información sobre este protocolo en https://www.odata.org/. Los detalles sobre esta norma OASIS están disponibles en https://www.oasis-open.org/standards#odatav4.0.

Dado que la API web se basa en estándares abiertos, no proporcionamos ensamblados para una experiencia de desarrollador específica. Puede crear solicitudes HTTP para operaciones específicas o usar bibliotecas de terceros para generar clases para cualquier idioma o plataforma que desee. Puede encontrar una lista de bibliotecas compatibles con OData versión 4.0 en https://www.odata.org/libraries/.

API web y el servicio de organización

Es útil reconocer que el servicio de organización es lo que define la plataforma. La API web proporciona una experiencia de programación RESTful, pero en definitiva todas las operaciones de datos pasan por el servicio de organización subyacente. El servicio de organización define las operaciones admitidas como mensajes. Cada mensaje tiene un nombre. Estos nombres están asociados con los eventos que se usan en el marco de trabajo de eventos para evaluar qué extensiones registradas hay que iniciar. Más información: Marco de trabajo de eventos

La API web permite hacer las mismas operaciones que el SDK para NET, pero las presenta con estilo RESTful. OData v4 permite usar operaciones con nombre mediante funciones o acciones. La mayoría de los mensajes disponibles en el servicio de organización se exponen como una función o acción con nombre correspondiente. Esos mensajes que se corresponden con operaciones CRUD no están disponibles en la API web porque, al ser un servicio, RESTful, tienen implementaciones que usan los métodos GET, POST, PATCH, y DELETE HTTP pero dentro de la plataforma los mensajes recuperar, crear, actualizar y eliminar solo se invocan tal cual cuando se realizan las operaciones correspondientes mediante los ensamblados SDK para .NET.

Comenzar

Puede usar la API web con cualquier lenguaje que le permita enviar solicitudes HTTP autenticadas. Preparamos algunas experiencias de introducción para cuatro escenarios comunes:

Herramientas de solicitud HTTP

Una aplicación que le permita redactar y enviar solicitudes HTTP autenticadas es un primer paso esencial. Hay muchos disponibles, como Postman, Bruno o curl. Elige y usa el que más te guste. Proporcionamos algunos pasos para usar Insomnia porque tiene una interfaz gráfica de usuario, una instalación relativamente fácil y brinda la opción de optar por no crear una cuenta. Aprender a usar Insomnia para trabajar con la API web de Dataverse

Propina

A menos que ya tenga una herramienta de solicitud HTTP favorita, es posible que descubra que el uso de PowerShell con Visual Studio Code es igual de fácil de comenzar y también permite potentes capacidades de scripting.

Desarrolladores de PowerShell

El uso de la API web con PowerShell es una de las formas más sencillas de empezar. Puede usar el cmdlet Invoke-RestMethod para enviar solicitudes y procesar las respuestas mediante el cmdlet ConvertTo-Json.

Puede encontrar el siguiente contenido sobre el uso de PowerShell con la API web:

Desarrolladores de JavaScript

Los desarrolladores de JavaScript utilizan con frecuencia la API web de Dataverse con aplicaciones basadas en modelos. Las aplicaciones basadas en modelos proporcionan el objeto Xrm.WebApi que expone métodos para interactuar con la API web. Más información sobre JavaScript del lado del cliente mediante API Web en aplicaciones basadas en modelo.

Las aplicaciones de una sola página (SPA) también usan JavaScript y pueden conectarse a la API web de Dataverse. Guía rápida: API web con JavaScript y Visual Studio Code del lado cliente describe cómo conectarse a el API web mediante un patrón de aplicación SPA. Puede encontrar más casos en Ejemplos de operaciones de datos de el API web (lado cliente JavaScript).

Entre los componentes de Power Apps Component Framework (PCF), los desarrolladores de JavaScript usan métodos que forman parte del objeto WebAPI para trabajar con datos de Dataverse en componentes PCF.

Por último, Power Pages expone una API web de portales que ofrece un subconjunto de operaciones de Dataverse disponibles mediante la API Web.

Desarrolladores de .NET

Los desarrolladores de .NET pueden usar el SDK para .NET de Dataverse o la API Web. Es posible que desee usar la API Web cuando no desee depender de un paquete específico de NuGet o cuando los requisitos del proyecto no requieran las clases fuertemente tipadas que proporciona el SDK para .NET.

Para usar la API Web con C#, consulte estos artículos de inicio rápido:

Hay muchos más ejemplos de API web de C# en Ejemplos de operaciones de datos de API web (C#)

Trabajar con datos mediante código
OData - lo mejor para REST
OData Versión 4.0 Parte 1: Protocol Plus Errata 02
OData Versión 4.0 Parte 2: URL Conventions Plus Errata 02
OData Versión 4.0 Parte 3: Common Schema Definition Language (CSDL) Plus Errata 02