Release Notes

Changelog

Generación de Token para Consumo de las APIs del RUB


Objetivo

Disponibilizar un proceso estandarizado para la generación y utilización de tokens de autenticación de las APIs del RUB, permitiendo que sistemas externos realicen integraciones de forma segura, controlada y alineada con los permisos configurados en el entorno.


La autenticación de las APIs del RUB se basa en credenciales generadas dentro del propio sistema, asociadas a permisos específicos y utilizadas mediante el encabezado Authorization en las solicitudes.


Contexto de la Demanda

Con la expansión del uso de las APIs del RUB para integraciones con sistemas de terceros, se volvió frecuente la necesidad de orientar a los equipos técnicos sobre:


Hasta ahora, estas orientaciones eran compartidas principalmente a través de tickets de soporte o comunicaciones individuales, aumentando los tiempos de atención y dificultando la estandarización del proceso.


Con esta documentación, el procedimiento pasa a contar con una referencia oficial para consulta e implementación.


Solución Implementada

El RUB proporciona un mecanismo de autenticación basado en:


Después de crear una aplicación, el sistema genera automáticamente las credenciales necesarias para la autenticación de las APIs.


Estas credenciales deberán utilizarse para construir el encabezado de autenticación de las solicitudes.


Requisitos Previos

Antes de iniciar la configuración, es necesario contar con acceso al entorno RUB Central con permisos para administrar las configuraciones de Interface.


También se recomienda que el responsable de la integración tenga conocimientos básicos sobre:


Paso a Paso de Configuración

1. Acceder al Programa Interface

En RUB Central, acceda al programa:

Interface


Programa Interface

2. Abrir el Registro de Permisos

En el menú superior izquierdo, acceda a:

Configuraciones → Permisos


Menú Permisos

3. Crear un Nuevo Permiso

Agregue un nuevo permiso.

En el detail Permisos, asigne los controles de acceso necesarios para el consumo de las APIs.

Para la generación del token, se recomienda incluir permisos de las categorías:


Registro de Permiso

4. Abrir el Registro de Aplicaciones

En el menú superior izquierdo, acceda a:

Configuraciones → Aplicaciones


Menú Aplicaciones

5. Crear una Nueva Aplicación

Agregue una nueva aplicación.

Al guardar el registro, el RUB mostrará un mensaje con:


⚠️ Importante:

Esta información será utilizada posteriormente para autenticar las APIs.

Guarde estos datos en un lugar seguro.


Datos de Clave y Token

6. Vincular el Permiso a la Aplicación

Después de crear la aplicación, asocie el permiso creado anteriormente a su registro.


Vinculación de Permiso

Utilización del Token en las APIs

Después de obtener los datos de:

debe construirse la credencial utilizando el siguiente formato:

TEXT
{clave}:{token}

Ejemplo:

TEXT
abc123:def456789xyz

Conversión a Base64

El valor compuesto debe convertirse a Base64.

Ejemplo:

TEXT
YWJjMTIzOmRlZjQ1Njc4OXh5eg==

Header de Autenticación

Después de la conversión, el header de la solicitud deberá enviarse de la siguiente forma:

HTTP
Authorization: Basic YWJjMTIzOmRlZjQ1Njc4OXh5eg==

Ejemplo de Solicitud

HTTP
GET /api/ejemplo HTTP/1.1
Host: servidor.rub.com.br
Authorization: Basic YWJjMTIzOmRlZjQ1Njc4OXh5eg==
Content-Type: application/json

Flujo Resumido

  1. Crear un Permiso;

  2. Configurar los controles de acceso necesarios;

  3. Crear una Aplicación;

  4. Obtener la Clave y el Token;

  5. Asociar el Permiso a la Aplicación;

  6. Construir el texto en el formato:

    TEXT
    clave:token

  7. Convertir a Base64;

  8. Enviar en el header:

    HTTP
    Authorization: Basic {tokenBase64}

Beneficios


Observaciones