Skip to content

Latest commit

 

History

History
329 lines (257 loc) · 12.5 KB

README.md

File metadata and controls

329 lines (257 loc) · 12.5 KB
Raw

Transbank POS SDK Node.js

SDK Oficial de Transbank para comunicarse con POS Verifone vx520, vx520c, Ingenico 3500 y POS Autoservicio

Requisitos

  • Node.js 10+
  • NPM
  • Yarn (recomendable)

Instalación

Para instalar este SDK en tu proyecto, solo debes incluirlo usando npm/yarn.

npm install transbank-pos-sdk

¿Cómo se usa?

Como se explica más abajo, la documentación oficial está en Transbank developers, pero como una breve introducción:

//Dependiendo del modelo de POS
const { POSAutoservicio } = require('transbank-pos-sdk');
const { POSIntegrado } = require('transbank-pos-sdk');

const pos = new POSIntegrado();
pos.setDebug(true);

pos.autoconnect() // Esta línea permite busca en todos los puertos si existe uno que tenga conectado un equipo POS y se intenta conectar con el primero que encuentra. 
    .then((port) => {
        if (port === false) {
            console.log('No se encontró ningún POS conectado')
        }  

        console.log('Connected to PORT: ', port.path)
        pos.loadKeys() // Cargar llaves
    })
    .catch((err) => { console.log('Ocurrió un error inesperado', err) })

Métodos

La mayoría de los métodos devuelve un Promise que al resolverse devuelve la respuesta del POS o el resultado de la operación

setDebug(true/false)

Habilita/Deshabilita el que se imprima información de debug en la consola.

pos.setDebug(true);

autoconnect()

Este método permite en un solo comando buscar un POS dentro de los puertos disponibles y conectarse automáticamente al primer POS que encuentre (en caso de haber más de uno)

pos.autoconnect().then( (response) => {
    console.log(response);
}).catch( (err) => {
    console.log('Ocurrió un error inesperado', err);
});

listPorts()

Devuelve una lista de los puertos del computador disponibles para conectarse.

pos.listPorts().then( (ports) => {
    console.log(ports);
}).catch( (err) => {
    console.log('Ocurrió un error inesperado', err);
});

connect(portName)

Este método permite en un solo comando buscar un POS dentro de los puertos disponibles y conectarse automáticamente al primer POS que encuentre (en caso de haber más de uno).

let portName = '/dev/tty.usb2412412'; //Ejemplo En caso de mac
let portName = 'COM4'; //Ejempo en caso de windows
pos.connect(portName).then( (response) => {
    console.log('Conectado correctamente');
}).catch( (err) => {
    console.log('Ocurrió un error inesperado', err);
});

disconnect()

Desconectar (cerrar conexión serial) con el POS actualmente conectado.

pos.disconnect().then( (response) => {
    console.log('Puerto descontactado correctamente');
}).catch( (err) => {
    console.log('Ocurrió un error inesperado', err);
});

isConnected()

Devuelve true en caso de que exista una conexión activa con el POS y false en caso contrario

let connected = pos.isConnected();

getConnectedPort()

Devuelve el puerto al que se está conectado en caso de que exista una conexión activa con el POS y false en caso contrario.

let connectedToPort = pos.getConnectedPort();

send(payload, waitResponse = true, callback = null)

Este comando, si bien es de uso interno, es posible usarlo públicamente y permite enviar un payload al POS. Este es el método que ocupan todos los siguientes helpers para comunicarse con el POS.

Este método devuelve una promesa. Si waitResponse es false esta promese se resuelve cuando el comando es recibido correctamente por el POS (se recibe ack). Si waitResponse es true la promesa se resuelve cuando llega un mensaje de respuesta del POS (ejemplo, cuando la venta termina y el POS envía el resultado de esta venta).

payload es el mensaje a enviar. Puede ser un string ("0200") o un Array de bytes en hexadecimal ([0x20, 0x32, 0x10]).

Si callback es una función, esta se ejecutará cada vez que el POS envíe algo. Se usa para obtener los status intermedios de una venta que se envían antes de que llegue la respuesta final.

pos.send('0500||', false) // Cerrar día  con waitResponse false
    .then( (response) => {
        console.log('Comando enviado correctamente (se recibió ack del POS)', response);
    }).catch( (err) => {
        console.log('Ocurrió un error inesperado', err);
    });

pos.send('0500||', true) // Cerrar día con waitResponse true
    .then( (response) => {
        console.log('Respuesta recibida por el POS', response);
    }).catch( (err) => {
        console.log('Ocurrió un error inesperado', err);
    });

poll()

Ejecuta un comando poll en el POS.

pos.poll().then( (response) => {
    console.log('poll ejecutado. Respuesta: ', response);
}).catch( (err) => {
    console.log('Ocurrió un error inesperado', err);
});

loadKeys()

Ejecuta un comando loadKeys en el POS.

pos.loadKeys().then( (response) => {
    console.log('loadKeys ejecutado. Respuesta: ', response);
}).catch( (err) => {
    console.log('Ocurrió un error inesperado', err);
});

closeDay()

Ejecuta un comando closeDay en el POS.

pos.closeDay().then( (response) => {
    console.log('closeDay ejecutado. Respuesta: ', response);
}).catch( (err) => {
    console.log('Ocurrió un error inesperado', err);
});

getLastSale()

Ejecuta un comando getLastSale en el POS.

pos.getLastSale().then( (response) => {
    console.log('getLastSale ejecutado. Respuesta: ', response);
}).catch( (err) => {
    console.log('Ocurrió un error inesperado', err);
});

getTotals()

Ejecuta un comando getTotals en el POS.

pos.getTotals().then( (response) => {
    console.log('getTotals ejecutado. Respuesta: ', response);
}).catch( (err) => {
    console.log('Ocurrió un error inesperado', err);
});

salesDetail(printOnPos = false)

Obtiene detalle de las ventas del POS. printOnPos indica si se desea imprimir en papel el detalle de ventas en el POS. Si printOnPos es true, el POS no enviará respuesta al computador y solo lo imprimirá, por lo que la promesa de respuesta se ejecutará cuando llegue el ack de que el POS recibió el comando. En caso contrario, la promesa se resuelve cuando llega la lista con todas las ventas.

pos.salesDetail().then( (response) => {
    console.log('salesDetail ejecutado. Respuesta: ', response);
}).catch( (err) => {
    console.log('Ocurrió un error inesperado', err);
});

refund(operationId)

Ejecuta un comando refund en el POS. operationId es el ID de la operación que se desea anular.

pos.refund('102').then( (response) => {
    console.log('refund ejecutado. Respuesta: ', response);
}).catch( (err) => {
    console.log('Ocurrió un error inesperado', err);
});

changeToNormalMode()

Ejecuta un comando changeToNormalMode en el POS.

pos.changeToNormalMode().then( (response) => {
    console.log('changeToNormalMode ejecutado. Respuesta: ', response);
}).catch( (err) => {
    console.log('Ocurrió un error inesperado', err);
});

sale(amount, ticket, sendStatus = false, callback = null)

Ejecuta un comando sale en el POS. amount es el integer que representa el monto a pagar. ticket es un número de ticket que te permita referenciar la venta internamente.

Si sendStatus es false el POS solo enviará un mensaje cuando se termine el proceso de venta. Si sendStatus es false el POS enviará mensajes a medida que se va avanzando en el proceso (se selecciona método de pago, el usuario pasa la tarjeta, se ingresa la clave, etc). Estos mensajes de estados intermedios se pueden capturar definiendo una función en el parámetro callback

// Venta simple sin estados intermedios
pos.sale(1500, '12423').then( (response) => {
    console.log('sale finalizado. Respuesta: ', response);
}).catch( (err) => {
    console.log('Ocurrió un error inesperado', err);
});

// Venta con estados intermedios
let callback = function (data) {
    console.log('Mensaje intermedio recibido:  ', data)
}
pos.sale(1500, '12423', true, callback)
    .then( (response) => {
        console.log('sale finalizado. Respuesta: ', response);
    }).catch( (err) => {
        console.log('Ocurrió un error inesperado', err);
});

Proyecto de ejemplo

El SDK Web de POS integrado está construido en Node.js, usando este SDK por debajo. Puedes revisar el código acá.

Documentación

Puedes encontrar toda la documentación de cómo usar este SDK en el sitio https://www.transbankdevelopers.cl.

La documentación relevante para usar este SDK es:

Información para contribuir y desarrollar este SDK

Estándares generales

  • Para los commits nos basamos en las siguientes normas: https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#commits 👀
  • Usamos inglés para los nombres de rama y mensajes de commit 💬
  • Todas las mezclas a master se hacen mediante Pull Request ⬇️
  • Se pueden usar tokens como WIP en el subject de un commit, separando el token con :, por ejemplo -> "WIP: this is a useful commit message ✅
  • Se asume que una rama de feature que no se encuentra mezclada no esta terminada⚠️
  • El nombre de las ramas debe ir en minúsculas y las palabras se deben separar con - 🔤
  • El nombre de las ramas debe comenzar con alguno de los short lead tokens definidos. Por ejemplo: feat/tokens-configurations 🌿

Short lead tokens

WIP = En progreso

feat = Nuevos features

fix = Corrección de un bug

docs = Cambios solo de documentación

style = Cambios que no afectan el significado del código (espaciado, formateo de código, comillas faltantes, etc)

refactor = Un cambio en el código que no arregla un bug ni agrega una funcionalidad

perf = Cambio que mejora el rendimiento

test = Agregar test faltantes o los corrige

chore = Cambios en el build o herramientas auxiliares y librerías

Rules 📖

1️⃣ - Si no se añaden test en el pull request, se debe añadir un video o gif mostrando que el cambio no afecta el funcionamiento.

2️⃣ - El pull request debe tener 2 o más aprobaciones para poder mezclarse.

3️⃣ - Si un commit revierte un commit anterior deberá comenzar con "revert:" seguido del mensaje del commit anterior.

Pull Request

Asunto ✉️

  • Debe comenzar con el short lead token definido para la rama, seguido de : y una breve descripción del cambio.
  • Usar un lenguaje imperativo y en tiempo presente: "change" no "changed" ni "changes".
  • No usar mayúscula en el inicio.
  • No usar punto al final.

Descripción 📃

  • Usar lenguaje imperativo y en tiempo presente.
  • Detallar los cambios que agrega el PR.
  • Todo PR debe incluir test, en caso de no contar con test, se debe incluir evidencias de que el cambio no afecta el funcionamiento.
  • Se pueden usar gif o videos para complementar la descripción o evidenciar el funcionamiento.

Generar una nueva versión (con deploy automático a NPM)

Para generar una nueva versión, se debe crear un PR (con un título "Prepare release X.Y.Z" con los valores que correspondan para X, Y y Z). Se debe seguir el estándar semver para determinar si se incrementa el valor de X (si hay cambios no retrocompatibles), Y (para mejoras retrocompatibles) o Z (si sólo hubo correcciones a bugs).

En ese PR deben incluirse los siguientes cambios:

  1. Modificar el archivo CHANGELOG.md para incluir una nueva entrada (al comienzo) para X.Y.Z que explique en español los cambios de cara al usuario del SDK.
  2. Modificar el archivo package.json y modificar la versión

Luego de obtener aprobación del pull request, debe mezclarse a master e inmediatamente generar un release en GitHub con el tag vX.Y.Z. En la descripción del release debes poner lo mismo que agregaste al changelog.

Posteriormente, se debe hacer el release en npm. Esto se hace de forma manual usando npm publish. Se debe estar logeado npm login con la cuenta de TransbankDevelopers