Manual de uso 
Informações
Nome do aplicativo: emDia
Cliente: Santander EmDia
Número da proposta: 4122020
| Versão |
Data da atualização | O que foi feito? |
Autor |
| 1.0.0 | 01/03/2021 | Construção do documento | Lucas Macedo |
| 1.1.0 | 08/03/2021 | Adição da seção de instalação do aplicativo | Lucas Macedo |
Contexto
O app para consultar clientes e suas as informações (dívidas, acordos e parcelas) deve permitir fazer o download do boleto da parcela e do termo de quitação do acordo utilizando de APIs autenticadas do sistema emDia.
Como funciona
Sempre que um ticket é visualizado, o app procura o CPF nos campos personalizados do usuário requisitante e faz a busca na API da emDia.
Caso seja encontrado o CPF no sistema emDia, é carregado algumas informações pessoais do cliente como e-mail, telefone, nome completo e etc, seguido por suas dívidas, acordos e parcelas.
Observações:
- Esse app também pode ser usado quando um agente estiver na área de criação de um novo ticket, porém nesse momento será apresentado uma barra de pesquisa para que encontre um cliente pelo CPF.
- Só será exibido a lista de dívidas caso o cliente possua alguma no sistema emDia e a mesma regra se repete para acordos e parcelas.
Como utilizar
Atualização dos dados para acesso a API
Caso necessário, pode ser alterado posteriormente e para isso, acesse a área administrativa (clicando na engrenagem na lateral esquerda), clique no menu “Gerenciar”, localize o aplicativo com a seta do mouse e clique no ícone do aplicativo para alterar as configurações, conforme imagem abaixo:
Na tela de configurações do aplicativo, é possível visualizar os detalhes do aplicativo e os campos personalizados que são utilizados para autenticação na API da emDia.
Obs: Todos os campos seguem o padrão de campos recebidos pela API de autenticação da emDia com o prefixo _em_dia .
Obs: Na instalação do aplicativo são utilizados valores padrões informados previamente.
Localização do aplicativo no Zendesk
No print a seguir podemos identificar o aplicativo emDia carregado, após abrir um ticket existente no Zendesk.
Visualização de dados do cliente
Aqui podemos visualizar alguns dados do cliente como CPF. nome completo, E-mail, celular e etc, todas elas vindas do sistema emDia.
Logo abaixo dos dados do cliente, temos dois botões, um para alterar os dados do cliente e o outro para excluí-lo do sistema emDia e Zendesk.
Obs: Caso o cliente só exista no sistema emDia, ele será deletado somente lá.
Alteração de dados do cliente
Para alterar os dados do cliente basta clicar no botão “Alterar dados”, conforme mostrado no print anterior. E após o clique, será aberto um modal permitindo alterar algumas informações do cliente como nome, telefone e e-mail.
Lembrando que, aqui todos os campos são obrigatórios e algumas validações são feitas pela API da emDia, como exemplo o e-mail não pode ser repetido.
Após alterar os dados desejados basta clicar no botão “Salvar” para atualizar os dados no sistema emDia e em seguida será atualizado o e-mail do usuário no Zendesk para manter o e-mail atualizado nos dois sistemas.
Exclusão de cliente
Para excluir um cliente basta clicar no botão “Excluir Cliente”, conforme mostrado no print sobre a visualização dos dados do cliente. Após clicar no botão, será aberto um pequeno modal de confirmação, para confirmar ou não a exclusão do cliente.
Essa é uma ação perigosa, pois se ação de exclusão for feita ela é irreversível.
Lembrando que só será possível excluir um cliente caso todos os tickets estejam com o status fechado no Zendesk e não possua nenhum acordo na emDia.
Obs: O status fechado no Zendesk só pode ser definido utilizando os gatilhos ou automações do próprio Zendesk.
Caso tente excluir um cliente que possua um ou mais acordos na emDia a seguinte mensagem será exibida:
Caso tente excluir um cliente que possua tickets no Zendesk e algum deles possua um status diferente de fechado a seguinte mensagem será exibida:
Caso o processo de exclusão tenha ocorrido com sucesso e o cliente não exista no Zendesk a seguinte mensagem será exibida:
Por último, caso o processo de exclusão tenha ocorrido com sucesso e o cliente exista no sistema Zendesk e emDia a seguinte mensagem será exibida:
Visualização de dívidas
Abaixo da seção sobre os dados do cliente e os botões de ação, podemos visualizar cards com informações sobre as dívidas do cliente, caso existam.
E nesses cards das dívidas, além de alguns dados da dívida temos na lateral direita uma barra verde que sinaliza quando a dívida em questão possui no mínimo um ( 1 ) acordo.
Obs: No card da dívida, a informação do “Acordo” vem do último acordo vinculado a dívida ou caso a dívida não possua nenhum acordo, virá com o valor “Não”.
Visualização de acordos de uma dívida
Após escolher uma dívida que possua um acordo e clicar no card, será aberto um modal com as mesmas informações da dívida no topo e logo abaixo temos uma tabela de acordos.
O termo de quitação do acordo só estará disponível, caso o status do mesmo seja pago, o que implica que todas as parcelas foram quitadas.
Visualização de parcelas de um acordo
No modal de visualização de acordos, clique na linha de um acordo que possua alguma parcela e após isso a linha vai expandir, exibindo as parcelas vinculadas a esse acordo.
Após expandir o acordo tornando visível a lista de parcelas, na última coluna à direita haverá dois botões, são eles:
Baixar - será utilizado para baixar o boleto da parcela e o mesmo só estará disponível caso o sistema emDia consiga gerar o link de download.
Copiar - será utilizado para copiar a linha digitável e esse botão só estará disponível caso o sistema emDia devolva na API a linha digitável.
Barra de pesquisa de cliente
Para que a barra de pesquisa seja exibida, é necessário que o agente esteja na área de criação de um novo ticket.
Essa barra de pesquisa permite que seja feita uma busca de cliente por CPF no sistema emDia através das APIs. Para utilizar basta digitar o CPF que procura e clicar no botão com a lupa lupa ao lado, após isso será feito uma pesquisa no sistema emDia pelo CPF e caso seja encontrado um cliente o aplicativo vai carregar com todas as funcionalidades mencionadas anteriormente.
Detalhes técnicos
Segue todos os endpoints utilizados no app:
Autenticação
- POST - /auth/realms/backend/protocol/openid-connect/token -> Parâmetros enviados:
- client_id
- username
- password
- grant_type
- client_secret
- scope
Estes parâmetros estão em modo seguro na configuração do app, e portanto, não estão visíveis no inspetor do navegador
Cliente
- GET - /client/admin/customer/info/{CPF} -> Busca informações básicas do cliente pelo CPF
- GET - /client/admin/customer/detail/{client_id} -> Busca informações do cliente, juntamente com dívidas, acordos e parcelas pelo id do cliente no sistema emDia
- GET - /client/admin/customer/score/{client_id} -> Busca os dados de score do cliente no sistema emDia pelo id do cliente
- PUT - /admin/registration-correction -> Atualiza as informações do cliente com os seguintes parâmetros:
- clientID
- name
- emailAddress
- phoneArea
- phoneNumber
- DELETE - /ticket/admin/delete/{client_id}-> Exclui o cliente do sistema emDia
Acordo
- POST - /client/admin/customer/discharge-term -> Busca o termo de quitação do acordo com os seguintes parâmetros:
- documentNumber
- arrangementID
- clientID
Parcela
- POST - /client/admin/customer/download-billet -> Busca o boleto da parcela com os seguintes parâmetros:
- clientID
- installmentID
Comentários
0 comentário
Por favor, entre para comentar.