REST API INTEGRATION PROTOCOL
DESCRIPCIÓN:
Deben seguirse las reglas especificadas en este documento. En caso de errores, se ruega comunicarlo con el equipo de ImaCash con la mayor brevedad posible para poder solucionarlo.
CONFIGURACIÓN:
Mientras se utiliza esta integración, debe configurarse un endpoint en ImaCash para recibir las solicitudes correspondientes. Esta configuración se realizará en la interfaz de ImaCash.
Los parámetros DB Name, User, Password, Database IP y Database Port se utilizan para configurar la base de datos donde la API guardará las ventas. Si se dejan con los valores por defecto utilizará la misma base de datos que utiliza ImaCash para almacenar sus datos. El parámetro API Port permitirá configurar en que puerto estará abierta la API para recibir peticiones.1 – 2
Cada ImaCash configurado podrá comunicarse con una máquina, en caso de tener varias máquinas, deberá configurar múltiples ImaCash en diferentes dispositivos con diferentes endpoints.
1 Dependiendo de la configuración del router, puede que sea necesario redireccionar este puerto para que sea visible fuera de la red de la tienda.
2 Puede ser necesario iniciar ImaCash con modo administrador, de lo contrario pueden surgir errores
PETICIONES:
POST Transaction
Utilizando esta función POST, el cliente podrá enviar una transacción a ImaCash.
*Tenga en cuenta que el campo ID debe ser ÚNICO. El importe debe estar en céntimos, y tiene que ser
mayor que cero.
GET TransactionStatus
Mediante esta función, el cliente podrá obtener el estado de una transacción identificada por su parámetro `id_sale`.
POST CancelTransaction
Mediante esta función, el cliente podrá cancelar una transacción identificada por su parámetro `id_sale`. Devuelve un mensaje por el body.
