Introducción

El API de Delfín Software es un servicio adicional del producto Delfín Software que permite la consulta de información a través del estándar OData, lo que facilita la integración con aplicaciones de otros proveedores de software.

CARACTERÍSTICAS OPERACIONALES

Tipo de servicio: Lo primero que hay que tener en cuenta, es que este API opera bajo el estándar OData. Las personas que deseen usar los servicios del API preferiblemente deben tener conocimientos básicos sobre el estándar ODATA, del cual se puede encontrar toda la documentación en el siguiente enlace OData - the Best Way to REST.

URL de acceso: Cuando se instala el API de Delfín Software se asigna una URL de acceso, la que luego es usada para consumir el servicio. Ejemplo de URL de acceso: http://192.168.0.1/DelfinAPI/

Formato de respuesta: Los servicios que usan el estándar OData por defecto responden con formato XML, pero es posible cambiar a formato JSON simplemente adicionando a cada solicitud el siguiente queryString: $format=json Para los ejemplos de este documento siempre vamos a utilizar el formato JSON.

Entidades: Son todas aquellas partes de información del sistema que se pueden consultar, como por ejemplo: Productos, Clientes, Categorías, Ventas, etc.