API Docs

Definicion

ePolca pone a servicio del cliente una API de integracion para consultar y enviar datos, como la importacion y sincronizacion de OFs.

La documentacion tecnica del uso de la API se puede encontrar en el siguiente enlace:

https://epolca.innovait.cat/api/redoc

Autenticacion

Para poder utilizar la API de ePolca es necesario disponer de un token de conexion suministrado en el momento en el que se da acceso a la aplicacion ePolca. Ese token debera ser enviado en la cabecera de autenticacion como Bearer Token en cada peticion que se realice a la API.

• Ejemplo

Authorization: "Bearer secret"

Donde secret seria el token personalizado de cliente.

Uso de la API para importacion de OFs

En el momento de importar datos es importante tener en cuenta una serie de consideraciones:

1. Hacerlo de forma parcial, para un optimo rendimiento y obtener una respuesta en un periodo razonable. El sistema, por cada OF, realiza una serie de comprobaciones y calculos antes de la insercion en base de datos. Por ello se recomienda no realizar envios con bloques demasiado grandes de datos.
2. No enviar todos los registros cada vez; intentar importar unicamente los registros que hayan tenido cambios durante la jornada, para evitar sobrecargar el sistema con informacion redundante que ya existe.
3. Evitar importar los registros finalizados desde hace tiempo. Las OFs terminadas hay que enviarlas en algun momento para que ePolca las marque como finalizadas; por lo tanto se recomienda limitar la importacion de OFs terminadas en las ultimas 24/48h. Pasado ese tiempo, no hace falta enviarlas mas.
4. Evitar solapamientos entre las importaciones y las simulaciones automaticas, ya que los dos procesos trabajan sobre los mismos registros y provocan bloqueos e incoherencias de datos.
5. Si la peticion de importacion da un error con codigo 503 con el mensaje de sistema ocupado, se recomienda volver a intentar la peticion pasados 5 minutos, una vez el sistema se libere.