Renegociação v2
Uma das aplicabilidades do Serviço API Rest é o processo de Renegociação, que se refere à ação de negociar dívidas dos clientes, utilizando o BankPlus, em que se é possível aplicar multas, juros, taxas e até mesmo descontos.
 | Atenção | |||||||
| Para melhor visualização das imagens, clique sobre elas. | ||||||||
Para utilizarmos o serviço de Renegociação v2 via API Rest é necessário abrir o InventApps e criar um serviço com o tipo API Rest, após isso clicar no botão Generate Token, Salve o Token gerado no botão no canto superior:
Depois no botão Iniciar para salvar a chave de autorização que será usada no Postman para a obtenção dos resultados dos métodos disponíveis:
Observação | ||||||||
Sempre que precisar reiniciar os serviços, gere primeiro o Token e depois clique em Reiniciar, depois cole o Token no portal ou no Postman e siga com o processo normalmente. | ||||||||
A URL é composta pelo Nome do Servidor, e as demais informações configurado no serviço, conforme ilustrado na imagem abaixo:
| Importante | ||||||||
Anteriormente com o antigo monitor de serviços se tornava necessário informar um apelido para a base que o serviço estaria instalado na URL, mas agora não se faz necessário, pois o novo invent apps a validação é realizada pela porta configurada no serviço, mesmo que haja apelido informado, a requisição é realizada pelo Postman corretamente, segue um print de uma requisição realizada com sucesso: | ||||||||
Observe agora a execução dos métodos de Renegociação v2:
1. Método para buscar as parcelas de uma renegociação - Get Parcelas Renegociação:
Esse método busca todas as parcelas em aberto de uma renegociação, geradas no BankPlus, a partir do ID da empresa e do código do Parceiro de Negócios, vinculados à renegociação em questão.
Após copiar o Token da tela do serviço API Rest, vá até o Postman, selecione o método GET Parcelas Renegociação à esquerda, clicando sobre ele. Depois, na aba Headers - campo Value à direita, cole o Token e clique no botão Send conforme a imagens abaixo:
Observe a aba Headers e o seu campo Value:
Observe a chave de autorização ou o Token colado no campo Value na linha de Authorization:
Após clicar no botão Send, podemos ver no campo inferior à direita, no Postman, uma das parcelas em aberto e suas informações, lembrando que o método retorna todas as parcelas da renegociação vinculada ao PN e à Empresa informados na URL, na imagem abaixo vemos apenas a primeira da lista:
Observe que ao clicar sobre o método na lista à esquerda, no Postman, aparecerá a URL desse método à direita:
No nosso exemplo, usamos a Empresa de código 1 e o PN de código C20000.
Observe que a URL é composta pelo Nome do Servidor e o Apelido do banco de dados, inserido na configuração do serviço, observe nas imagens abaixo:
 | Dica | |||||||
| O nome do ambiente deve ser alterado para corresponder com a base SAP em que as consultas estão sendo realizadas. | ||||||||
2. Método de busca pela Renegociação a partir de seu ID - Get Obter Renegociação por Id:
Esse método busca uma renegociação, com todas as suas parcelas, a partir do número de seu ID, que no Add-on equivale ao código dessa renegociação. Acompanhe abaixo as imagens ilustrando esse processo:
Na tela de Renegociação do BankPlus, podemos verificar o ID da Renegociação, na coluna código:
Na tela do Postman, na aba Headers e no seu campo Value, especificamente na linha Authorization, colamos o Token, gerado no serviço do Add-on:
Após clicar no botão Send, podemos observar o resultado, ainda na tela do Postman, à direita no campo inferior. Temos a renegociação cujo ID no nosso exemplo é 4:
Note que a URL contém o ID (4) da renegociação ao final: GET [http://localhost:9992/api/v2/QA/cobranca/1/renegociacao/4]. Observe também, que antes da categoria "renegociação", é necessário informar o ID da Empresa, conforme está no SAP, que no nosso exemplo é 1.
Agora detalharemos o método de enviar comandos por meio do portal ao BankPlus utilizando o método POST.
3. Método para salvar uma renegociação no Postman - Post Salvar Renegociação:
Esse método permite que uma renegociação seja criada no próprio portal ou no Postman e enviada, com todas as suas informações, para o BankPlus.
Na tela do Postman, no campo Value, na linha de Authorization, da aba Headers, cole o Token gerado no serviço API Rest do Add-on, em seguida clique no botão Send para executar o método:
Token colado no respectivo campo:
Abra a aba Body, ainda no Postman, e preencha as informações da parcela manualmente no campo inferior da tela, como por exemplo, o código do parceiro de negócios vinculado à renegociação, data da geração dessa renegociação, sua data de vencimento e outros dados, veja na imagem abaixo esses campos já preenchidos:
Após clicar em Send, retorne à aba Headers e confira o resultado no campo abaixo, também no Postman, com todas as informações da renegociação gerada no portal, veja abaixo:
Confira essa mesma renegociação gerada no Postman, listada no Add-on:
Um detalhe importante nesse método está na sua URL, observe que ao final dela existe "aprovar=N" por padrão, que se deixado assim, gerará uma renegociação com status de "Aguardando Aprovação", como no nosso exemplo acima.
Mas se mudarmos o "N" (não) por "S" (sim), geraremos uma renegociação com status "Aprovada", veja abaixo:
Veja no Add-on o status "Aprovada" da renegociação enviada pelo Postman com o aprovar=S:
Agora iremos detalhar o método PATCH para Aprovar, Reprovar e Cancelar uma Renegociação.
4. Método para aprovar uma renegociação, buscando-a pelo seu ID - Patch Aprovar Renegociação:
Esse método executará a Aprovação de uma renegociação com status "Aguardando Aprovação" no Add-on, para isso é necessário informar o ID dessa renegociação na URL do método. Veja o processo por meio das imagens abaixo:
Na tela do Postman, após colar o Token no campo Value, em sua linha Authorization, da aba Headers, informe o ID da renegociação que deseja aprovar na URL do método e na sequência clique em Send:
Observe no campo abaixo, ainda na tela do Postman ilustrada acima, a mensagem de que a renegociação de ID 6 foi aprovada. Lembrando que renegociações Canceladas ou Reprovadas não poderão ser Aprovadas.
5. Método para reprovar uma renegociação por meio do seu ID - Patch Reprovar Renegociação:
Esse método reprova uma renegociação que está com status de "Aguardando Aprovação" ou "Aprovada" no Add-on e para isso ocorrer, é necessário informar o ID dessa renegociação na URL do método. Lembrando que o ID de uma renegociação é o código desta no Add-on, como já foi dito acima. Acompanhe as imagens destacando os campos e informações importantes nesse processo:
Cole o Token na linha Authorization do campo Value, na aba Headers, isso após clicar sobre o método à esquerda. Em seguida, clique em Send, veja abaixo:
Veja que no nosso exemplo, utilizamos a renegociação de ID 5, informada na URL. Essa renegociação foi reprovada com sucesso, conforme a mensagem do campo abaixo na imagem.
6. Método para Cancelar uma renegociação - Patch Cancelar Renegociação:
Com esse método podemos cancelar uma renegociação, tanto com status "Aguardando Aprovação", "Aprovada" ou mesmo "Reprovada". Basta clicar sobre esse método no Postman, à esquerda na lista de métodos, em seguida, colar o
Token gerado no serviço do Add-on na aba Headers, campo Value, especificamente na linha Authorization e na sequência clicar em Send, acompanhe o procedimento na imagem abaixo:
Token gerado no serviço do Add-on na aba Headers, campo Value, especificamente na linha Authorization e na sequência clicar em Send, acompanhe o procedimento na imagem abaixo:
Note que na URL é preciso informar o ID da renegociação a ser cancelada, no nosso exemplo foi o ID 5.
Observe os resultados desses métodos na tela de Renegociação do Add-on:
Na coluna Status, podemos visualizar os resultados dos métodos PATCH:
