Introducción

El API de Delfín Software opera bajo el estándar OData, lo que permite realizar operaciones sobre los datos del sistema de forma estructurada y compatible con múltiples herramientas.

💡 Recomendación: Para aprovechar al máximo el API, es ideal tener conocimientos básicos sobre el estándar OData. Puedes consultar la documentación oficial en https://www.odata.org/.

🌐 URL de acceso

Durante la instalación del API se asigna una URL que será utilizada para consumir los servicios.
Ejemplo de URL de acceso:
http://localhost/DelfinAPI/

🧱 Entidades

Las entidades representan los distintos conjuntos de datos que se pueden consultar a través del API, como:

• Productos
• Clientes
• Categorías
• Ventas
• ...entre otros

🔍 Visualizar entidades disponibles

Para consultar el listado de entidades disponibles, agrega la siguiente ruta a la URL de acceso:

/v1/OrganizacionOData.svc

📦 Formato de respuesta

Por defecto, los servicios OData responden en formato XML.
Sin embargo, puedes obtener las respuestas en JSON agregando el siguiente parámetro a la solicitud:

?$format=json

En esta guía, todos los ejemplos utilizarán el formato JSON para facilitar la lectura y el análisis.

Ejemplo completo en formato JSON:

http://(URLAcceso)/v1/OrganizacionOData.svc/?$format=json

La visualización puede variar dependiendo del navegador y los complementos instalados.

🧬 Visualizar metadata

Para conocer la estructura de las entidades, incluyendo sus propiedades y claves primarias, utiliza la siguiente ruta:

/v1/OrganizacionOData.svc/$metadata

Esta información se presenta siempre en formato XML y es útil para entender cómo interactuar con cada entidad.