Skip to main content

Autorização MD2 Portal do Titular - comunicação com portal do cliente

Objetivo

O processo de autenticação por token do cliente é método mais seguro para a passagem do CPF/CNPJ ao MD2 Portal do Titular. Foi desenvolvido seguindo os padrões de mercado e boas práticas de consumo de API’s.

A documentação a seguir apresenta detalhes técnicos que devem ser seguidos para funcionamento correto da solução.

Funcionamento

A configuração do MD2 Portal do Titular é efetuada no arquivo configPortal.properties em conjunto com a tela de Parâmetro do Portal do Titular no Quality Manager. O Quality Manager recebe o token gerado pelo cliente e repassa durante a transferência do usuário do portal do cliente para o MD2 Portal do Titular.

Após receber o token, o MD2 Portal do Titular utiliza a configuração no arquivo configPortal.properties e na tela de Parâmetro do Portal do Titular, previamente feita, para acessar a API informada nos parâmetros, e consulta informando o token e esperando como retorno o número do CPF/CNPJ do titular.

Somente após este processamento, o MD2 Portal do Titular será liberado para a uso.

Os padrões descritos abaixo de envio do token repassado pelo cliente para a API de validação exposta e do retorno do CPF/CNPJ são os aceitos pela aplicação. Outros formatos não são suportados.

Configuração

Tela de Parâmetro do Portal do Titular

A tela de Parâmetro do Portal do Titular armazena funções para que o MD2 Portal do Titular receba o token, enviado pelo portal do cliente, e o encaminhe para a o backend, que faz a validação através da API configurada.

Link com as informações para configuração na tela de parâmetros do Portal do titular: Tela de Parâmetro do Portal do Titular


A configuração da tela de Parâmetro do Portal do Titular é de responsabilidade do cliente, porque pode variar conforme o parâmetro será repassado do seu portal do cliente para o portal do titular, portanto os exemplos acima são somente dois casos dos vários que podem existir.

Arquivo configPortal.properties

O arquivo configPortal.properties contém as informações de configuração do servidor (comunicação do Portal do titular com o Quality Manager).

image.png

API

A validação disparada pelo MD2 Portal do Titular é feita através do consumo de uma API e que pode ser feita através dos métodos GET e POST. 

Método GET

image.png

1 – Informe a URL da API para a validação do token

Por padrão a aplicação sempre envia o token para a API do cliente no padrão Authorization Bearer

Exemplo de requisição padrão:

curl --location --request GET 'http://hostCliente:8080/servico/api/validaToken' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2MjY4OTUyOTUsInVzZXJfbmFtZSI6InFtX3NlcnZpY2UiLCJqdGkiOiJlNWJiMWVmMC0xM2Y5LTQ4MTQtOTkzNC05N2I4N2M3YTY3M2YiLCJjbGllbnRfaWQiOiJhbmd1bGFyLWFwcCIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdfQ.8LuS0tNPVjQ9Xy9G9AmN7_2TSP-andWXA4qW_9iIArs' \
--data-raw ''

2 – Em caso de retorno do CPF/CNPJ por uma variável, informar nesse parâmetro o nome do atributo de retorno. Tipo de retorno aceitos:

    1 - Número do cpf/cnpj direto sem formatação

11111111111

     2 - JSON

{ "cpf" : "11111111111" }

O nome do atributo cpf foi apenas com caráter ilustrativo, o sistema irá buscar o nome do atributo com base no que for informado no parâmetro 3

3 – Nesse parâmetro informe o verbo a ser utilizado para o consumo do serviço: (GET)

Método POST

Veja abaixo a interface de configuração de integração do MD2 Portal do Titular com a API responsável pela validação e retorno do documento (CPF).

image.png

1 – Informe a URL da API para a validação do token

2 – Para consumo de API pelo verbo POST, o token é enviado no parâmetro Authorization Bearer. Não informe nenhum valor em "authenticationParameterEnv". Exemplo de requisição:

curl --location --request POST 'http://hostCliente:8080/servico/api/validaToken' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE2MjY4OTUyOTUsInVzZXJfbmFtZSI6InFtX3NlcnZpY2UiLCJqdGkiOiJlNWJiMWVmMC0xM2Y5LTQ4MTQtOTkzNC05N2I4N2M3YTY3M2YiLCJjbGllbnRfaWQiOiJhbmd1bGFyLWFwcCIsInNjb3BlIjpbInJlYWQiLCJ3cml0ZSJdfQ.8LuS0tNPVjQ9Xy9G9AmN7_2TSP-andWXA4qW_9iIArs' \
--data-raw ''

3 – Em caso de retorno do CPF/CNPJ por uma variável, informar nesse parâmetro o nome do atributo de retorno. Tipo de retorno aceitos:

    1 - Número do cpf/cnpj direto sem formatação

11111111111

     2 - JSON

{ "cpf" : "11111111111" }

O nome do atributo cpf foi apenas com caráter ilustrativo, o sistema irá buscar o nome do atributo com base no que for informado no parâmetro 3

4 – Nesse parâmetro informe o verbo a ser utilizado para o consumo do serviço: (POST)

Referências


Direitos autorais © 2022 MD2 Informática LTDA.

No Comments
Back to top