Tipos y operaciones de API web

  • Artículo

Los artículos de esta sección le ayudarán a entender la API web de Dataverse ya que presentan conceptos importantes y le muestran formas de obtener la información que necesitará a través de los documentos de servicio.

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

Primeros pasos

Lo primero que debe hacer es buscar en los documentos de servicio un entorno de Dataverse al que puede acceder. Para ello necesitará conocer la URL de su entorno. Luego, le recomendamos que configure algunas formas de administrar la autenticación en el servicio para ver los documentos del servicio.

Encuentre la URL del extremo de la API web

Use las instrucciones en Ver recursos para desarrolladores para identificar un extremo de la API web para un entorno al que pueda acceder. Debería tener aspecto similar a éste: https://yourorg.api.crm.dynamics.com/api/data/v9.2

Autenticación al servicio

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

Puede usar cualquier método para recuperar fácilmente los documentos de servicio y ver ejemplos que muestran cómo la información de los artículos de esta sección se aplica a su entorno. Puede también realizar cualquier otra operación para probar las funciones de la API web.

Configurar un entorno de Insomnia

El cliente API de Insomnia proporciona una excelente manera de conectarse a sus entornos y explorar la API web de Dataverse. Insomnia puede simplificar en gran medida la administración de obtener un token de acceso utilizando la API web de Dataverse.

Utilice los pasos de Usar Insomnia con la API web de Dataverse

Usar PowerShell con Visual Studio Code

Utilice los pasos de Inicio rápido de API web con PowerShell y Visual Studio Code para autenticarse en el servicio. Usar PowerShell y Visual Studio Code con la API web de Dataverse expande el inicio rápido para describir formas más avanzadas de interactuar con la API web de Dataverse. La sección Descargar el documento de $metadata CSDL de API web de Dataverse contiene una secuencia de comandos para descargar el documento de CSDL $metadata.

Estándar de OData v4.0

Los artículos de esta sección resumen la información relevante para la implementación de la API web de Dataverse del estándar OData v4.0. Un servicio que implementa OData debe seguir los estándares establecidos en la especificación, pero no está obligado a implementar todas las partes de la especificación.

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

Pasos siguientes

Obtenga información sobre los documentos de servicio de la API web.

Documentos de servicio

Consulte también

Documentos de servicio de la API web
EntityTypes de la API web
Propiedades de API web
Propiedades de navegación de la API web
Acciones de la API web
Funciones de la API web
Tipos complejos y de enumeración de API web
Usar la API web de Dataverse
Autenticarse en Dataverse con la API web
Realizar operaciones mediante la API web

Nota

¿Puede indicarnos sus preferencias de idioma de documentación? Realice una breve encuesta. (tenga en cuenta que esta encuesta está en inglés)

La encuesta durará unos siete minutos. No se recopilan datos personales (declaración de privacidad).