Página 1 de 10

Sistema Para Puntos De Venta

MODO DE USO DEL API DELFÍN v1

Información adicional Ubíquenos

P.B.X.: (4) 604 19 99 Web: www.dlpsystems.co
Celular: 310.445.11.48 Ciudad: Medellín – Colombia
Email: servicio@dlpsystems.co
 Página 2 de 10

INTRODUCCIÓN
En DLP Systems somos conscientes de que la dinámica comercial de los negocios nos presenta
cada día nuevos retos y desafíos que debemos afrontar para ser más competitivos, ya sea
implementando nuevas estrategias de mercadeo o apoyándonos en tecnología adecuada y
actualizada.

Nuestra firma nace como una respuesta a la creciente necesidad de información y asesoría que
sobre esta materia requieren las empresas de Retail. El esfuerzo administrativo que demanda
mantener los datos y procesos al día en este tipo de negocio nos motivó a diseñar una solución
práctica y completa, especializada en controlar eficientemente los procesos que involucran el
punto de venta y que brinden las herramientas adecuadas para su administración: Delfín
Software®.

Una de las principales características de Delfín Software® es su versatilidad, ya que le permite

ajustarse a las necesidades específicas de cada empresa, independientemente de cual sea el
sector comercial al cual pertenece. Actualmente ofrecemos nuestros servicios a Supermercados,
Superetes, Tiendas de Abarrotes, Tiendas por Departamento, Almacenes, Restaurantes, Bares,
Discotecas, Hoteles, entre otros.

Somos una empresa con más de 20 años en el mercado, lo cual es garantía de cumplimiento y
servicio. Contamos con un grupo de profesionales con amplia experiencia en el negocio de
retail y completo conocimiento de las necesidades de los clientes finales.

Nuestro compromiso institucional es convertirnos en su mejor aliado estratégico y garantizarle

un retorno de la inversión a corto plazo.

Este manual le permitirá poner manos a la obra rápidamente. Aquí aprenderá como realizar las
tareas más comunes, y encontrará sugerencias.
 Página 3 de 10

API DE DELFÍN SOFTWARE

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.
 Página 4 de 10

PRIMEROS PASOS

Configuración: Después de tener instalado el API de Delfín Software, al momento de ingresar la

URL de acceso en un navegador de internet, debemos visualizar la siguiente página de
configuración, que permite asignar las rutas donde se encuentra instalado el sistema Delfín
Software y su base de datos:

Visualizar listado de entidades disponibles: Para visualizar el listado de entidades disponibles

que pueden ser consultadas a través del API, se debe adicionar a la URL de acceso la siguiente
ruta “/v1/OrganizacionOData.svc”, ejemplo:

http://<URLAcceso>/v1/OrganizacionOData.svc

El resultado de esta solicitud es retornando por defecto en formato XML, para cambiar el
resultado a formato JSON y como se hará de ahora en adelante para todos los ejemplos, se
debe adicionar a la solicitud el queryString $format=json de la siguiente forma:

http://<URLAcceso>/v1/OrganizacionOData.svc/?$format=json

* Esta información se visualizará distinto depende del navegador o los plugin instalados dentro
del navegador.
 Página 5 de 10

Visualizar metadata: Para visualizar la estructura de propiedades de todas las entidades con sus
claves primarias, se debe adicionar a la URL de acceso la siguiente ruta
“/v1/OrganizacionOData.svc/$metadata”, ejemplo:

http://<URLAcceso>/v1/OrganizacionOData.svc/$metadata

* Esta información siempre será visualizada en formato XML.

 Página 6 de 10

ENTIDADES MAS USADAS

A continuación, vamos a presentar un listado de las entidades más usadas y como consultarlas
a través de solicitudes HTTP que se pueden realizar a través un navegador web.

Categorías (Grupos):
http://<URLAcceso>/v1/OrganizacionOData.svc/Categoria/?$format=json

Sub Categorías (Sub Grupos):

http://<URLAcceso>/v1/OrganizacionOData.svc/SubCategoria/?$format=json

Productos:
http://<URLAcceso>/v1/OrganizacionOData.svc/Producto/?$format=json

Códigos de barras:
http://<URLAcceso>/v1/OrganizacionOData.svc/ProductoEan/?$format=json

Clientes:
http://<URLAcceso>/v1/OrganizacionOData.svc/Cliente/?$format=json

Centros de costo:
http://<URLAcceso>/v1/OrganizacionOData.svc/CentroCosto/?$format=json

Encabezado de ventas del mes de enero:

http://<URLAcceso>/v1/OrganizacionOData.svc/VentaEnero/?$format=json
* para otros meses solo se cambia en nombre del mes

Detalle de ventas del mes de enero:

http://<URLAcceso>/v1/OrganizacionOData.svc/VentaDetalleEnero/?$format=json
* para otros meses solo se cambia en nombre del mes

Medio de pago de las ventas:

http://<URLAcceso>/v1/OrganizacionOData.svc/VentaPago/?$format=json

Inventario diario del mes de enero:

http://<URLAcceso>/v1/OrganizacionOData.svc/InventarioDiarioEnero/?$format=json
* para otros meses solo se cambia en nombre del mes

Inventario acumulado por mes:

http://<URLAcceso>/v1/OrganizacionOData.svc/InventarioMensual/?$format=json
 Página 7 de 10

CONSULTA DE UNA ENTIDAD POR SU CAMPO CLAVE

Para conocer cuál es el campo clave de una entidad simplemente hay que consultar la
metadata como se indica más arriba en este documento.

Para consultar una entidad a través de su campo clave hay que adicionar entre paréntesis el
valor del código o la identificación dentro de la solicitud HTTP, de la siguiente forma:

Consultar el producto con código 000001:

http://<URLAcceso>/v1/OrganizacionOData.svc/Producto('000001')/?$format=json

Consultar el producto con código 000002:

http://<URLAcceso>/v1/OrganizacionOData.svc/Producto('000002')/?$format=json

Consultar el cliente con identificación 986741698-8:

http://<URLAcceso>/v1/OrganizacionOData.svc/Cliente('986741698-8')/?$format=json

Para aquellas entidades cuyo campo clave es compuesto, como es el caso de las ventas, se
procede de la siguiente forma:

Consultar el encabezado de venta de la Terminal 010101 con MesDia 0105 y Consecutivo 0001:
http://<URLAcceso>/v1/OrganizacionOData.svc/VentaEnero(Terminal='010101',MesDia='0105',C
onsecutivo='0001')/?$format=json

IMPORTANTE:
En el caso que se intente consultar un registro que no existe en el sistema, se retornará “Recurso
no encontrado para el segmento <Entidad>”, ejemplo de un producto que no existe:
 Página 8 de 10

OBTENER SOLO LAS COLUMNAS NECESARIAS

Hay ocasiones en que no es necesario obtener toda la información de una entidad, para lo cual
es importante reducir la cantidad de columnas del resultado, lo cual disminuye el tamaño de la
respuesta obteniendo en algunos casos un mejor rendimiento.

Para indicarle al servicio que columnas se desean obtener, se debe añadir al queryString el
valor:

$select=Columna1, Columna2, Columna3

Consultar el nombre de todos los productos:

http://<URLAcceso>/v1/OrganizacionOData.svc/Producto/?$format=json&$select=Nombre

Consultar el nombre del producto con código 000001:

http://<URLAcceso>/v1/OrganizacionOData.svc/Producto('000001')/?$format=json&$select=No
mbre

Consultar el código y el nombre de todos los productos:

http://<URLAcceso>/v1/OrganizacionOData.svc/Producto/?$format=json&$select=CodigoProd
ucto,Nombre
 Página 9 de 10

FILTRAR INFORMACIÓN

Normalmente no se consulta toda la información de una entidad, para lo cual es importante

filtrar solo los registros que son de interés, esto disminuye el tamaño de la respuesta
obteniendo en algunos casos un mejor rendimiento.

Para indicarle al servicio que filtros se desean aplicar, se debe añadir al queryString el valor:

$filter=Columna1 operador Valor

Consultar los productos cuyo nombre sea igual a LECHE:

http://<URLAcceso>/v1/OrganizacionOData.svc/Producto/?$format=json&$filter=Nombre eq
'LECHE'

Consultar los productos cuyo nombre sea diferente a LECHE:

http://<URLAcceso>/v1/OrganizacionOData.svc/Producto/?$format=json&$filter=Nombre ne
'LECHE'

Consultar los productos cuyo precio de venta sea mayor a 10000:

http://<URLAcceso>/v1/OrganizacionOData.svc/Producto/?$format=json&$filter=Venta1 gt
10000

Consultar los productos cuyo precio de venta sea mayor o igual 10000:
http://<URLAcceso>/v1/OrganizacionOData.svc/Producto/?$format=json&$filter=Venta1 ge
10000

Consultar los productos cuyo precio de venta sea menor a 10000:

http://<URLAcceso>/v1/OrganizacionOData.svc/Producto/?$format=json&$filter=Venta1 lt
10000

Consultar los productos cuyo precio de venta sea menor o igual a 10000:
http://<URLAcceso>/v1/OrganizacionOData.svc/Producto/?$format=json&$filter=Venta1 le
10000

Consultar los productos cuyo precio de venta sea mayor a 10000 y nombre igual a LECHE:
http://<URLAcceso>/v1/OrganizacionOData.svc/Producto/?$format=json&$filter=Venta1 gt
10000 and Nombre eq 'LECHE'
 Página 10 de 10

EJEMPLOS DE CONSULTAS COMUNES

A continuación, se van a presentar algunos ejemplos de consultas comunes a los servicios del
API de Delfín Software.

Consultar el cliente con identificación 986741698-8:

http://<URLAcceso>/v1/OrganizacionOData.svc/Cliente('986741698-8')/?$format=json

Consultar el producto con código 000001:

http://<URLAcceso>/v1/OrganizacionOData.svc/Producto('000001')/?$format=json

Consultar los códigos de barras del producto con código 000001:

http://<URLAcceso>/v1/OrganizacionOData.svc/ProductoEan/?$format=json&$filter=CodigoPr
oducto eq '000001'

Consultar los productos del grupo con código 01:

http://<URLAcceso>/v1/OrganizacionOData.svc/Producto/?$format=json&$filter=startswith(Co
digoLargo, '01') eq true

Consultar el encabezado de venta de la Terminal 010101 con MesDia 0105 y Consecutivo 0001:
http://<URLAcceso>/v1/OrganizacionOData.svc/VentaEnero(Terminal='010101',MesDia='0105',C
onsecutivo='0001')/?$format=json

Consultar el encabezado de las ventas realizadas en un rango de fechas:

http://<URLAcceso>/v1/OrganizacionOData.svc/VentaEnero/?$format=json&$filter=FechaVenta
gt datetime'2020-01-01T00:00:00' and FechaVenta lt datetime'2020-01-31T23:59:59'

Consultar el encabezado de las ventas realizadas en un año especifico:

http://<URLAcceso>/v1/OrganizacionOData.svc/VentaEnero/?$format=json&$filter=year(Fecha
Venta) eq 2020

Consultar el detalle de las ventas de una factura especifica:

http://<URLAcceso>/v1/OrganizacionOData.svc/VentaDetalleEnero/?$format=json&$filter=Ter
minal eq '010101' and MesDia eq '0105' and Consecutivo eq '0001'

Consultar entradas y salidas (Inventario) del producto 000001 en el mes de junio para el centro
de costos 0101:
http://<URLAcceso>/v1/OrganizacionOData.svc/InventarioMensual/?$format=json&$filter=Codi
goProducto eq '000001' and CodigoCentroCosto eq '0101' and month(Fecha) eq 6