transbank-onepay-frontend-sdk

Transbank JavaScript SDK Onepay

Requerimientos

Cualquier navegador que soporte ECMAScript 5 o superior

Navegadores soportados

Por temas de seguridad y para proveer la mejor experiencia para tus clientes que usaran tu aplicación de pago, no damos soporte a navegadores que han dejado de recibir actualizaciones de seguridad y que actualmente representan la minoría del trafico.

Si bien hemos realizado pruebas completas y exitosas usando Microsoft Internet Explorer 11 te recomendamos usar alguno de los navegadores listados a continuación:

• Microsoft Edge en sus versiones mas recientes
• Las versiones mas recientes de Google Chrome y Safari en todas las plataformas
• Mozilla Firefox en sus versiones para Desktop mas recientes
• Se requiere soporte de TLS 1.2 en todos los navegadores

Instalación

Agrega el siguiente HTML justo antes de cerrar tu etiqueta body:

<script>
    (function (o, n, e, p, a, y) {
        var s = n.createElement(p);
        s.type = "text/javascript";
        s.src = e;
        s.onload = s.onreadystatechange = function () {
            if (!o && (!s.readyState
                || s.readyState === "loaded")) {
                y();
            }
        };
        var t = n.getElementsByTagName("script")[0];
        p = t.parentNode;
        p.insertBefore(s, t);
    })(false, document, "https://unpkg.com/transbank-onepay-frontend-sdk@1/lib/merchant.onepay.min.js",
        "script",window, function () {
            console.log("Onepay JS library successfully loaded.");
        });
</script> 

Nota que la URL https://unpkg.com/transbank-onepay-frontend-sdk@1/lib/merchant.onepay.min.js cargará la ultima versión 1.x.x disponible. De esa forma te asegurarás de tener las últimas correcciones y nuevas funcionalidades (retrocompatibles) de manera automática.

Sin embargo, algunos comercios/integradores preferirán ser mas conservadores y sólo recibir actualización automática de correcciones (pero no funcionalidades nuevas). Para eso, debes cambiar la URL anterior por https://unpkg.com/transbank-onepay-frontend-sdk@1.5/lib/merchant.onepay.min.js.

Y en caso que prefieras que cualquier actualización de este SDK deba ser actualizado manualmente por tí (y no recibir actualización automática ni siquiera de correcciones) entonces debes cambiar la URL anterior por https://unpkg.com/transbank-onepay-frontend-sdk@1.5.10/lib/merchant.onepay.min.js.

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:

• Documentación general sobre el producto Onepay.
• Documentación sobre ambientes, deberes del comercio, puesta en producción, etc.
• Primeros pasos con Onepay.
• Referencia detallada sobre Onepay.

Información para contribuir y desarrollar este SDK

Standares

• Para los commits respetamos las siguientes normas: https://chris.beams.io/posts/git-commit/
• Usamos ingles, para los mensajes de commit.
• 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
• Para los nombres de ramas también usamos ingles.
• Se asume, que una rama de feature no mezclada, es un feature no terminado.
• El nombre de las ramas va en minúsculas.
• Las palabras se separan con -.
• Las ramas comienzan con alguno de los short lead tokens definidos, por ejemplo: feat/tokens-configuration

Short lead tokens

Commits

• WIP = Trabajo en progreso.

Ramas

• feat = Nuevos features
• chore = Tareas, que no son visibles al usuario.
• bug = Resolución de bugs.

Todas las mezclas a master se hacen mediante Pull Request.

Instalar dependencias para el desarrollo:

npm install

Construir sdk localmente:

npm run build

Generar una nueva versión

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. Actualizar los números de versiones en la sección de instalación de este archivo README.md (en el snippet de ejemplo y en los párrafos que le siguen según corresponda).

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. Con eso Travis CI generará automáticamente una nueva versión de la librería y la publicará en el registro público de NPM, para poder descargar la librería desde el cdn UNPKG.

Es buena práctica luego actualizar los proyectos de ejemplo para que usen la nueva versión liberada.