Primeros pasos

Prueba la funcionalidad rápidamente, regístrate y crea tu primera aplicación, aquí te decimos cómo.

Paso 1: Empieza a usar la consola de Banorte

 

Menú de navegación del Portal de Desarrolladores de Banorte

Menú de navegación del Portal de Desarrolladores de Banorte

No hay mejor manera de probar y tener una idea clara sobre la API de Banorte que en la consola.

En el menú de navegación, ve a la sección de Productos.

Lista de transacciones del Producto

Lista de transacciones del Producto

A continuación, Banorte te presenta el listado de transacciones para el API. Selecciona un servicio para proceder a realizar una prueba.

Smart docs del API Pagos / Devolución Referenciada

Smart docs del API Pagos / Devolución Referenciada

El portal Banorte desplegará toda la configuración que debes considerar para consumir el API, como el Endpoint, verbo HTTP, tipo de transacción, el Header y el Body. La siguiente imagen muestra con más claridad, lo que deberías estar viendo.

Indicador para el verbo HTTP

Indicador para el verbo HTTP

POST, representa el verbo HTTP del API

URL para SandBox

URL para SandBox

EndPoint para SandBox. Es la URL que el desarrollador debe usar para realizar pruebas en ambiente SandBox.

Preview de los parámetros para el HEADER

Preview de los parámetros para el HEADER

Parámetros para el HEADER. ¡Importante! todos los valores son requeridos.

Content-Type: Formato para el cuerpo del mensaje: JSON/XML.

X-Banorte-Hmac-Token: Código de autenticación usando la función HMAC-SHA512 de 512 bits.

Authorization: Token de acceso de tipo Bearer con OAuth 2.0.

X-Banorte-Hmac-Nonce: Doce caracteres alfanuméricos aleatorios usados como entrada al cómputo de X-Banorte-Hmac-Token.

X-Banorte-Hmac-Issued: Epoch (Unix time) del momento en que se computa X-Banorte-Hmac-Token.

Preview, para crear el HMAC con el Client ID y el Client Secret

Preview, para crear el HMAC con el Client ID y el Client Secret

Antes de enviar la solicitud genera el HMAC y el JWT Token

Haz click en el botón CREAR HMAC

El Client ID y el Client Secret ya están generadas exclusivamente para peticiones anónimas. A continuación haz click en Crear HMAC, NONCE & ISSUED.

Preview para crear el JWT Token

Preview para crear el JWT Token

Podrás observar que se cargaron automáticamente los valores. Ahora solo falta crear el JWT TOKEN, haz clic en en botón NEGOCIAR JWT TOKEN

El Client Private Key ya está generada exclusivamente para peticiones anónimas.

Una vez completado el proceso, todos los parámetros del HEADER estarán completos.

Vista preliminar del esquema de los valores del API

Vista preliminar del esquema de los valores del API

¡Listo! en el paso 5 completamos la carga de todos los valores para el HEADER.

*Antes de realizar la petición, revisa los valores que recibe el API.

*La siguiente imagen muestra el esquema de cada valor. Como la descripción, el valor mínimo y máximo.

Por último haz click en el botón ENVIAR. Esto realizará una petición al servidos al servicio solicitado.

Cuerpo de la repuesta

Cuerpo de la repuesta

La siguiente imagen muestra la respuesta de la petición. Si todo va bien debería responder con un estatus 200 lo que indica que la solicitud fue exitosa. Para más información revisa la tabla de estatus.

Si lo deseas puedes inspeccionar el cuerpo del resquest que se envía en solicitud. Te servirá como referencia para tu propio código.

Otra forma de realizar solicitudes a un API, es con la ayuda de CURL. Puedes ver la pestaña para obtener el comando.

Paso 2: Crea una Cuenta

Sigue los siguientes pasos para crear una cuenta propia en el Portal de Desarrolladores de Banorte:

Formulario para el registro de nuevos usuarios

Formulario para el registro de nuevos usuarios

  • Selecciona del menú de usurio, la opción Registro.

  • Captura tus datos para tu nuevo usuario y presiona clic en el botón CREAR NUEVA CUENTA.

     

    Características del nuevo Usuario.

    Todos son campos requeridos.

    El usuario está vinculado a la aplicación, en caso de que sea un usuario para una empresa es necesario que sigas las normativas de usuario de tu compañía.

    Además te recomendamos de leer atentamente el Términos de uso de las Aplicaciones

Correo electrónico que recibe el usuario al terminar el registro

Correo electrónico que recibe el usuario al terminar el registro

  • Una vez que enviés el formulario, Banorte te hará lleagar un correo electrónico de confirmación.

    Utiliza el primer link para cambiar tu contraseña.

    Después de realizar el cambio, ingresa a la siguiente liga para iniciar sesión.

     

    Tips del correo electrónico.

    En caso de que no recibas el correo pasados 5 minutos verifica tu bandeja de correo no deseado

    Puedes copiar y pegar el primer link en tu navegador, una vez completado haz lo mismo con el siguiente.

    El primer link sólo funciona una vez, en caso de que pierdas el proceso puedes Recuperar contraseña.

Paso 3: Generación de SSH Key

Una SSH Key, una pública y una privada, se conforma de dos archivos que tienen la característica de realizar conexiones a múltiples servidores sin la necesidad de ingresar una contraseña por la red.

Con este método un posible atacante no podrá interceptar y descifrar la contraseña ya que nunca será enviada.

La SSH siempre genera dos archivos, una llamada llave privada y otra llave pública. La llave privada únicamente debe ser conocida por el usuario que las crea y deberá ser almacenada con precaución. La llave pública en cambio puede ser compartida con libertad a cualquier servidor SSH con el que se quiera conectar. Es necesario crear sus propias API Key para crear nuevas aplicaciones dentro de la API de Banorte.

Diversos servidores utilizan la autenticación a través de las SSH Key y el proceso para generarlas es similar en los diferentes sistemas operativos. Lo primero es asegurarse que no se tenga ya con una llave.

Por defecto, las SSH Key se guardan en el directorio ~/.ssh de cada usuario. Se puede verificar su contenido en GNU/Linux o en Mac OS X por medio de los siguientes comandos en la Terminal:

  $ cd ~/.ssh
  $ ls
  id_rsa    id_rsa.pub
        

O en el Windows Power Shell para el Sistema operativo Windows:

  C:\ cd
  C:\Users\usuario\>dir .ssh
        

En caso de que exista el directorio y tengan llaves creadas con anterioridad se desplegará algo similar a lo siguiente:

  C:\Users\usuario\>dir .ssh
  Directorio de C:\Users\usuario\.ssh
  21/09/2018  12:00 p.m.                       1831 id_rsa
  21/09/2018  12:00 p.m.                       405 id_rsa.pub
        

Normalmente el nombre de los archivos serán id_rsa y id_rsa.pub, pero pueden tener otro nombre.

En caso de que exista el directorio puedes copiar la llave pública con el siguiente comando.

Copiar llave publica

Copiar llave publica

Un resultado parecido al siguiente obtendrás al ejecutar el comando anterior.

Resultado de ejecutar el comando anterior

Resultado de ejecutar el comando anterior

En caso de que no exista el directorio o los archivos puede proceder a crearlos según tu sistema operativo.

Generar llave en Windows

El sistema operativo Windows no dispone por defecto de un cliente SSH, aunque en la actualidad se está desarrollando una aplicación Open SSH nativa, sin embargo para entornos productivos desaconsejamos el uso de versiones beta.

Explicaremos cómo generarlas por medio de PuTTY y Git Bash.

PuTTY

PuTTY es un cliente SSH para Windows. Putty es un software Open Source y puedes descargarlo gratuitamente desde su página oficial https://www.putty.org/. Una vez que instalado PuTTY puedes generar la SSH Key con los siguientes pasos:

  1. Abra el programa PuTTYgen

    Programa PuTTY

    Programa PuTTY

  2. En el apartado Type of key to generate, seleccione SSH-2 RSA.

  3. Haz clic en el botón Generate.

  4. Mueve el mouse en el área bajo la barra de progreso. Cuando la barra esté completa, PuTTYgen generará los archivos.

    Barra de progreso para generar llave en PuTTY

    Barra de progreso para generar llave en PuTTY

  5. Ingrese la passphrase en el campo Key passphrase y confirme en el campo Confirm passphrase con la misma frase. Es posible generar la llave sin passphrase, pero se desaconseja.

  6. Clic en los botones Save private key y Save public key para guardar los archivos. Es necesario guardarla y aconsejamos que sea en el directorio ~./.ssh/.

     Ventana para guardar llave de PuTTY

    Ventana para guardar llave de PuTTY

Git Bash

En la instalación de Git Bash viene incluido SSH, puedes descargarlo desde la página oficial https://git-scm.com/download/. Cuando realices la instalación asegúrate de seleccionar las opciones:

  • Use OpenSSL library

  • Checkout Windows-style

  • Commit Unix-style line endings

Para generar la SSH Keys ejecute la aplicación Git Bash:

  $ cd C:\Users\usuario
  $ mkdir .ssh
  $ cd .ssh
  $ ssh-keygen.exe
          

Cuando termine, el resultado debería ser similar al siguiente:

  Ssh-keygen.exe
  Generating public/private rsa key pair.
  Enter file in which to save the key (/c/Users/usuario/.ssh/id_rsa): /c/Users/usuario/.ssh/
  Enter passphrase (empty for no passphrase):
  Enter same passphrase again:
  Your identification has been saved in /c/Users/usuario/.ssh/
  Your public key has been saved in /c/Users/usuario/.ssh/
  The key fingerprint is:
  SHA256:jieniOIn20935n0awtn04n002HqEIOnTIOnevHzaI5nak usuario@correo
  The key's randomart image is:

   +---[RSA 2048]----+
   |*= =+.           |
   |O*=.B            |
   |+*o* +           |
   |o +o.  .         |
   | ooo  + S        |
   | .o.ooo* o       |
   |  .+o+*oo .      |
   |   .=+..         |
   |   Eo            |
   +----[SHA256]-----+

  $ dir .ssh
  id_rsa  id_rsa.pub
          

Con este proceso se generaron los archivos de la llave pública y privada.

Generar llave en GNU+Linux

Puedes generar las SSH Key en GNU/Linux usando la aplicación de Terminal.

  $ mkdir ~/.ssh
            

Escriba el siguiente commando para generar las llaves:

  $ ssh-keygen –t rsa
            

Pedirá la localización donde se guarden los archivos, recomendamos que sea en el directorio .ssh dentro de tu usuario.

  Enter file in wich to save the key (/home/usuario/.ssh/id_rsa):
            

Recomendamos que se ingrese una frase para generar la llave. Debes ingresar también una confirmación de la frase.

  Enter passphrase (empty for no passphrase):
            

El proceso complete se lista similar a lo siguiente:

  user@localhost: ssh-keygen -t rsa
  Generating public/private rsa key pair.
  Enter file in which to save the key (/home/youruser/.ssh/id_rsa):
  Enter passphrase (empty for no passphrase):
  Enter same passphrase again:
  Your identification has been saved in id_rsa.
  Your public key has been saved in id_rsa.pub.
  The key fingerprint is:
  16:8e:e8:f2:1d:c9:b9:cf:43:9a:b3:3c:c1:1f:95:93 user@localhost
            

Las SSH Keys se abrán generado correctamente.

Generar llave en macOS

Puedes generar las SSH Key en Mac OS X por medio de la aplicación de Terminal.

  • Para abrir Terminal, abre la carpeta de Utilidades en tu carpeta de Aplicaciones del Finder.

  • Haz doble clic en el ícono de Terminal.

Para generar la SSH Key

En caso de que no exista el directorio:

  $ mkdir ~/.ssh
  $ chmod go-rwx ~/.ssh
          

Acceda al directorio:

  $ cd ~/.ssh
          
  $ ssh-keygen –b 1024 -t rsa –f id_rsa –P ""
          
  Your identification has been saved in /Users/user/.ssh/id_rsa.
  Your public key has been saved in /Users/user/.ssh/id_rsa.pub.
  The key fingerprint is:
  ae:89:72:0b:85:da:5a:f4:7c:1f:c2:43:fd:c6:44:38 user@mymac.local
  The key's randomart image is:
  +--[ RSA 2048]----+
  |                 |
  |         .       |
  |        E .      |
  |   .   . o       |
  |  o . . S .      |
  | + + o . +       |
  |. + o = o +      |
  | o...o * o       |
  |.  oo.o .        |
  +-----------------+
          

Acceda al directorio:

  $ ls
  -rw-------   1 username  staff   887B Oct  1 11:35 id_rsa 
  -rw-r--r--   1 username  staff   239B Oct  1 11:35 id_rsa.pub
          

Conclusión

La llave pública es el archivo con la extensión pub y es necesario su contenido para la creación de Aplicaciones en la API de Banorte.

Puedes abrirlo con algún editor de texto simple o tu IDE favorita. Otra manera de ver el archivo es que en un Terminal ingreses el comando:

  $ cat id_rsa.pub
          

Copia y pega el contenido cuando vayas a crear una nueva aplicación en el campo obligatorio Llave Pública, omitiendo el primer texto hasta el espacio "ssh-rsa":

Paso 4: Registra tu aplicación

Elemento Mis aplicaciones en el menú de usuario

Elemento Mis aplicaciones en el menú de usuario

Listado de Mis aplicaciones

Listado de Mis aplicaciones

Se listarán "Mis aplicaciones" como lo puedes ver en la siguiente imagen.

Formulario Nueva Aplicación

Formulario Nueva Aplicación

Los campos son los siguientes, aquellos que están marcados con un * son requeridos:

  • Términos legales
  • Aviso de privacidad
  • Cuando inicies sesión en el portal, ve al menú Perfil de usuario y da clic en Mis aplicaciones.
    • Nombre de la aplicación*:

      Es un nombre que identifica a la aplicación, se recomienda que sea corta, descriptiva y referente a lo que se tratará.

      Características del nombre de la aplicación.

      El nombre debe ser único para cada desarrollador, por lo que no puede existir dos aplicaciones con el mismo nombre. Planea tus aplicaciones.

      Asegúrate que no sea demasiado grande para que no dificulte trabajar en las llamadas.

      Deberás evitar nombres inválidos para que no causen problemas en la certificación de tu aplicación.

    • Callback URL:

      Este campo apunta a una liga externa. Cuando la aplicación solicite credenciales de usuario no preguntará por un usuario y contraseña. En lugar de eso redireccionará al usuario final a esta URL. Se presume que tras un inicio de sesión que permita el Acess Token que se usará en las transacciones.

    • Llave pública*:

      La creación de la lave pública se detalla en el Paso 3: Generación de SSH Key.

    • Producto*:

      Selecciona el producto que busques. No olvides visitar el catálogo de productos para conocer más detalle de cada uno y elijas el que requieras.

Podrás registrar tu aplicación dando clic en el botón Registrar Aplicación.

Registrar aplicación

Mi primera aplicación

Da clic en el botón Registrar Aplicación".

¡Felicidades!. Ya registrarte tu aplicación.

¿Qué sigue?

Tu búsqueda no produjo ningún resultado, sin embargo, te recomendamos los siguientes enlaces que te pueden ser de utilidad.

Recuerda visitar la sección de noticias referentes a la API, siempre hay algo interesante para ti.