Release Notes

Changelog

Geração de Token para Consumo das APIs do RUB


Objetivo

Disponibilizar um processo padronizado para geração e utilização de tokens de autenticação das APIs do RUB, permitindo que sistemas externos realizem integrações de forma segura, controlada e aderente às permissões configuradas no ambiente.


A autenticação das APIs do RUB é baseada em credenciais geradas no próprio sistema, associadas a permissões específicas e utilizadas através do cabeçalho Authorization nas requisições.


Contexto da Demanda

Com a expansão do uso das APIs do RUB para integrações com sistemas terceiros, tornou-se frequente a necessidade de orientar equipes técnicas sobre:


Até então, essas orientações eram frequentemente repassadas por chamados de suporte ou comunicações individuais, aumentando o tempo de atendimento e dificultando a padronização do processo.


Com esta documentação, o procedimento passa a possuir uma referência oficial para consulta e implementação.


Solução Implementada

O RUB disponibiliza um mecanismo de autenticação baseado em:


Após a criação do aplicativo, o sistema gera automaticamente as credenciais necessárias para autenticação das APIs.


Essas credenciais deverão ser utilizadas na composição do cabeçalho de autenticação das requisições.


Pré-Requisitos

Antes de iniciar a configuração, é necessário possuir acesso ao ambiente RUB Central com permissão para administração das configurações de Interface.


Também é recomendável que o responsável pela integração possua conhecimento básico sobre:


Passo a Passo de Configuração

1. Acessar o Programa Interface

No RUB Central, acesse o programa:

Interface


Programa Interface

2. Abrir o Cadastro de Permissões

No menu superior esquerdo, acesse:

Configurações → Permissão


Menu Permissão

3. Criar uma Nova Permissão

Adicione uma nova permissão.

No detail Permissões, atribua os controles de acesso necessários para utilização das APIs.

Para geração do token, recomenda-se incluir as permissões das categorias:


Cadastro de Permissão

4. Abrir o Cadastro de Aplicativos

No menu superior esquerdo, acesse:

Configurações → Aplicativos


Menu Aplicativos

5. Criar um Novo Aplicativo

Adicione um novo aplicativo.

Ao salvar o cadastro, o RUB exibirá uma mensagem contendo:


⚠️ Importante:

Essas informações serão utilizadas posteriormente para autenticação das APIs.

Guarde os dados em local seguro.


Dados de Chave e Token

6. Vincular a Permissão ao Aplicativo

Após criar o aplicativo, associe a permissão criada anteriormente ao seu cadastro.


Vinculação de Permissão

Utilização do Token nas APIs

Após obter os dados de:

deve-se montar a credencial utilizando o seguinte formato:

TEXT
{chave}:{token}

Exemplo:

TEXT
abc123:def456789xyz

Conversão para Base64

O valor composto deverá ser convertido para Base64.

Exemplo:

TEXT
YWJjMTIzOmRlZjQ1Njc4OXh5eg==

Header de Autenticação

Após a conversão, o header da requisição deverá ser enviado da seguinte forma:

HTTP
Authorization: Basic YWJjMTIzOmRlZjQ1Njc4OXh5eg==

Exemplo de Requisição

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

Fluxo Resumido

  1. Criar uma Permissão;

  2. Configurar os controles de acesso necessários;

  3. Criar um Aplicativo;

  4. Obter Chave e Token;

  5. Associar a Permissão ao Aplicativo;

  6. Montar o texto no formato:

    TEXT
    chave:token

  7. Converter para Base64;

  8. Enviar no header:

    HTTP
    Authorization: Basic {tokenBase64}

Benefícios


Observações