Autenticação

Para utilizar nossos serviços, é preciso estar autenticado através da API de autenticação. A autenticação é feita através de um JSON Web Token (JWT) utilizando o protocolo OAuth 2.

Autenticação e tokens

Para começar, acesse o endpoint de autenticação e clique no botão testar:

Figura 1. Endpoint de autenticação e botão de teste.

Parâmetros para requisição

O endpoint possui dois headers. Dentro da plataforma as informações já estarão pré-preenchidas para facilitar o consumo do endpoint.

Headers

Figura 2. Elementos de header para obtenção de token.

Authorization: Hash de autorização. Elemento obrigatório e disponibilizado pela RPE. Essa informação já está disponível como default mas, caso contrário, copie e cole toda a string na área de teste presente na lateral da página do endpoint.

Content-Type: Elemento obrigatório, e que deve ser sempre application/x-www.form-urlencoded.

Request body

É no request body que as informações do token para a processadora de preferência serão inseridas:

grant_type: Método usado para obtenção do token. Aqui, sempre configurado como password.

username: Nome do usuário. Aqui se refere à processadora.

password: Senha.

Figura 3. Elementos para token específico da processadora.

Processadoras:

RPE: A RPE possui sua própria plataforma processadora, a Cards que utiliza o Horizon como orquestrador para o processamento de APIs e dados.

Dock: Devido à sinergia do segmento, a RPE trabalha em parceria com a Dock e sua plataforma processadora, a PCH. A integração entre as duas é feita através do Horizon.

Cada processadora possui informações específicas para geração de token.

Para Cards, utilize

username: rpe-sandbox
password: [email protected]

Figura 4. Informações de request body para processadora Cards.

Para Dock, utilize

username: rpe-sandbox-ext
password: [email protected]

Figura 5. Informações de request body para processadora Dock.

Clique no botão enviar para enviar a requisição.

Figura 6. Informações de requisição prontas para o teste. Aqui, token sendo gerado para Processadora Cards.

Com as credenciais corretas, o endpoint retornará um status code 200 e o token para utilização dos nossos serviços.

Figura 7. Token para processadora Cards gerado com sucesso.

Com o JWT, você já pode começar a testar nossos serviços. Para mais detalhes, leia nosso guia para testes.

O JWT é válido por 4 horas, e cada usuário pode ter até 20 tokens ativos ao mesmo tempo. Ao ultrapassar esse limite, é possível obter novos tokens, mas o mais antigo será automaticamente substituído.

Antes, tentativas adicionais de autenticação retornavam um status code 401. Agora, após a primeira autenticação, o token se renova automaticamente enquanto o mais antigo é invalidado.

Esta política de controle de sessões ativas por usuário garante a segurança e a eficiência da plataforma.

Problemas na autenticação

Credenciais com erro de escrita, contendo informações que não correspondem aos campos e ou que não permitem acesso à determinados serviços retornarão mensagens de erro. Tenha cuidado e atenção na hora de se autenticar e para entender melhor o status da sua requisição, leia nosso artigo sobre códigos de resposta.