Configuración Rest API
DESCRIPCIÓN:
En los casos en los que un software quiera integrarse con ImaCash pero no sea posible
hacerlo directamente debido a diferencias en la plataforma, etc. Hemos preparado un método
de integración API, utilizando el protocolo HTTP, e intercambiando datos en formato JSON
a través de peticiones http.
A través de la API, los integradores podrán enviar ventas a ImaCash permitiendo que este las
procese en el dispositivo de efectivo conectado.
*Para realizar operaciones con la máquina habrá que trabajar con la interfaz de ImaCash
directamente.
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
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.
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á modificar la transacción pendiente a cancelada identificada por su
parámetro `id_sale`.
