Operaciones y tipos de API web

Los artículos de esta área le ayudarán a comprender la API web de Dataverse introduciendo conceptos importantes y mostrando formas de obtener la información que necesita al comprender los documentos de servicio.

Al igual que microsoft Graph API, Dataverse Web API es un servicio OData RESTful. A diferencia de Microsoft Graph API, cada entorno tiene una dirección URL de organización diferente e incluye tablas y operaciones personalizadas que pueden ser únicas para cada entorno. Cada entorno es diferente debido al conjunto único de personalizaciones o soluciones instaladas.

Primeros pasos

Lo primero que debe hacer es examinar los documentos de servicio de un entorno de Dataverse al que puede acceder. Para ello, debe conocer la dirección URL de su entorno. A continuación, se recomienda configurar algunas maneras de administrar la autenticación en el servicio para ver los documentos de servicio.

Búsqueda de la dirección URL del punto de conexión de api web

Use las instrucciones de Visualización de recursos de desarrollador para identificar un punto de conexión de API web para un entorno al que puede acceder. Debería tener un aspecto similar al siguiente: https://yourorg.api.crm.dynamics.com/api/data/v9.2.

Autenticación en el servicio

Hay varias maneras de autenticarse para interactuar con el servicio. El insomnio es una opción popular con una amplia adopción. También puede usar PowerShell con Visual Studio Code.

Puede usar cualquiera de los métodos para recuperar los documentos de servicio y ver ejemplos que muestran cómo se aplica la información de los artículos de esta sección a su entorno. También puede realizar cualquier otra operación para probar las funcionalidades de la API web.

Configurar un entorno de insomnio

El cliente de la API de Insomnia proporciona una excelente manera de conectarse a sus entornos y explorar la API Web de Dataverse. El insomnio puede simplificar considerablemente la administración de la obtención de un token de acceso al usar dataverse Web API.

Siga los pasos descritos en Uso de Insomnio con Dataverse Web API.

Uso de PowerShell con Visual Studio Code

Siga los pasos descritos en Quick Start Web API con PowerShell y Visual Studio Code para autenticarse en el servicio. Usar PowerShell y Visual Studio Code con la API web de Dataverse amplía la guía de inicio rápido para describir formas más avanzadas de interactuar con la API web de Dataverse. La sección Download the Dataverse Web API CSDL $metadata document contiene un script para descargar el documento CSDL $metadata.

Estándar de OData v4.0

En los artículos de esta sección se resume la información relevante para la implementación de api web de Dataverse del estándar OData v4.0. Un servicio que implemente OData debe seguir los estándares establecidos en la especificación, pero no es necesario para implementar todas las partes de la especificación.

Para obtener más información, consulte estos documentos:

• Versión de OData: 4.0 Parte 1: Protocolo Plus Errata 03
• Versión de OData: 4.0 Parte 2: Convenciones de dirección URL y Errata 03
• Versión de OData: 4.0 Parte 3: Lenguaje de definición de esquema común (CSDL) más Errata 03
• Formato JSON de OData versión 4.0

Pasos siguientes

Obtenga información sobre los documentos del servicio API web.

Documentos de servicio

Consulte también

Documentos del servicio API web
Web API EntityTypes
Propiedades de api web
Propiedades de navegación de api web
Acciones de API web
Funciones de API web
Tipos complejos y enumeración de API web
Usar la API web de Dataverse
Autenticación en Dataverse con la API web
Realización de operaciones mediante la API web