Pular para o conteúdo principal
Envie uma solicitação Minhas solicitações

Ontex-Pier

Dev/Produto Droz
  • Atualizado

MANUAL DE USO                                                                             

 

Informações

Nome do aplicativo: Ontex-Pier

Cliente: Ontex

 

Histórico de modificações:

 

Versão

Data da atualização

O que foi feito?

Desenvolvedor Responsável

1.0.0

16/07/2021

App SideBar, App NavBar

João Victor Silva de Macedo

 

Contexto

Um projeto de dois aplicativos, para preencher os campos de tickets, com os dados financeiros de um cliente, montar uma lista com esses dados e enviar para à API da Pier processar estas requisições de pagamentos em um lote, e dar os devidos tratamentos. Além da possibilidade de baixar um comprovante de pagamento referente ao lote processado.

 

Como funciona

  • O app sidebar possui duas abas, “Pagamento” e “Comprovante”. Na aba de “Pagamento”, preencha o formulário com os dados financeiros do cliente, e o app irá adicionar a tag “pier_pagamento_agendado” colocando o ticket na fila de pagamentos agendados. Na aba de “Comprovante”, baixe o comprovante do lote de pagamentos da Pier.
  • O app navbar lista todos os tickets que possuem a tag “pier_pagamento_agendado”, e te dá a possibilidade de escolher quais pagamentos ao cliente incluir no lote que será enviado à Pier.

 

Como utilizar

Localização do aplicativo sidebar no Zendesk Suporte

Como ilustrado no print a seguir, o app “Ontex-Pier” estará localizado na sidebar do seu ticket. Para o app aparecer, é necessário que o campo “Ressarcir consumidor?” Esteja com o valor “Sim” e o campo “Opções de Ressarcimento” esteja com o valor “Reembolso”, além do ticket precisar estar criado.

 

Agendando um pagamento com o aplicativo sidebar

Para agendar um pagamento é necessário preencher os seguintes dados no formulário na aba “Pagamento”:

  • Nome:  Obrigatório. Informe o nome completo do cliente. Nome e sobrenome.
  • CPF: Obrigatório. Informe um CPF válido. O aplicativo não trabalha com CNPJ.
  • Agência: Obrigatório. Informe a agência bancária do cliente. Caso o número informado possua menos de 4 dígitos, será preenchido automaticamente com “0” à esquerda até ficar com a quantidade mínima de dígitos.
  • Dígito Agência: Não Obrigatório. Informe o dígito da agência bancária do cliente, caso exista.
  • Conta: Obrigatório. Informe os dados da conta bancária do cliente. Caso o valor informado possua menos de 9 dígitos, será preenchido automaticamente com “0” à esquerda até ficar com a quantidade mínima de dígitos.
  • Dígito Conta: Obrigatório. Informe o dígito da conta bancária do cliente
  • Valor: Obrigatório. Informe o valor a ser passado para a Pier. O valor não pode ser igual ou menor do que 0. Caso o valor seja maior do que o configurado no campo “recommendend_value” (Mais detalhes na seção de Detalhes Técnicos), uma mensagem aparecerá, alertando que você está passando um valor maior do que o recomendado.
  • Banco: Obrigatório. Uma lista com todos os bancos configurados no campo “Pier-Banco Lista”, será exibida. Escolha o banco do cliente na lista.
  • Tipo de conta: Obrigatório. Informe o tipo da conta do cliente, se é corrente ou poupança.

Se todos os dados acima estiverem corretos, clique no botão "Agendar pagamento”, na parte inferior do aplicativo, e ele irá preencher todos os campos de ticket referentes à Pier, mapeados na seção de Detalhes Técnicos, além de adicionar a tag pier_pagamento_agendado, no ticket. Após esse processo será exibida uma mensagem “Ticket possui um pagamento agendado”, na parte superior do app, como ilustra o print a seguir:

 

     

Baixando o comprovante do lote de pagamento

No app sidebar clique na aba “Comprovante”, se a Pier ainda não tiver processado o pagamento será exibida uma mensagem “Pagamento não foi processado pela Pier”, como ilustra o print a seguir:

 

 

Caso o pagamento já tenha sido processado, e os campos de ticket “Pier-Lote de pagamento” e “Pier-Status do pagamento”, estejam preenchidos, será exibido o botão de baixar comprovante e um texto mostrando o id do lote, em que esse pagamento foi processado. Confira na imagem a seguir:

 

 

Clique no botão “Baixar comprovante”, para fazer uma requisição na API da Pier, e baixar o comprovante do lote informado.

 

Localização do aplicativo navbar no Zendesk Suporte

Como ilustrado no print a seguir, o app “Ontex-Pier” estará localizado na NavBar da sua instância.

 

 

Caso seu usuário não tenha permissão para acessar o app NavBar, será exibida uma mensagem “Você não tem permissão para acessar essa área”. Mais detalhes dos usuários que possuem permissão para acessar o app na seção de “Detalhes Técnicos”.

 

Montando um lote de pagamento para enviar à Pier

O app NavBar, vai listar todos os tickets da sua instância que possua a tag “pier_pagamento_agendado”, como ilustra o print a seguir:

 

Se você não possuir nenhum ticket que atenda às condições acima, será exibida uma mensagem “Sem pagamentos agendados”. A seguir, uma lista com os detalhes das informações listadas nos cards do aplicativo NavBar:

  • O primeiro valor. É o assunto do ticket.
  • O segundo É o Id do ticket no Zendesk. É possível clicar nesse valor, e caso o faça, será redirecionado para uma nova aba com os dados do ticket clicado.
  • O terceiro. É o nome do cliente informado durante o preenchimento do formulário no app sidebar.
  • O quarto. É o CPF do cliente informado durante o preenchimento do formulário no app sidebar.
  • O quinto. É o valor informado durante o preenchimento do formulário no app sidebar.
  • O sexto. É a data de agendamento, que é registrado quando um pagamento é agendado através do app sidebar.

Ao final da lista de tickets, será exibido 3 botões, como ilustra a imagem a seguir:

 

   

  • Marcar todos. Clique neste botão para marcar todos os tickets da lista. Após clicar nesse botão ele será trocado automaticamente para o botão “Desmarcar todos”, clique para desmarcar todos os tickets selecionados.
  • Recarregar. Clique neste botão, para realizar uma nova busca no Zendesk, e trazer novos tickets que possam ter sido agendados.
  • Enviar. Depois que tiver selecionado quais pagamentos deseja enviar neste lote, clique neste botão e será exibido um modal, como todos os tickets que você selecionou. Ilustração a seguir:

 

Caso tenha certeza dos tickets selecionados, clique no botão “Confirmar” para enviar os pagamentos à Pier. Depois da resposta da Pier, será mostrado uma mensagem “Pagamentos enviados à Pier - Id Lote: {Id do lote retornado pela Pier}”. Com isso os tickets que você selecionou sofreram as seguintes atualizações:

  • A tag “pier_pagamento_agendado” será removida
  • A tag “pier_pagamento_enviado” será adicionada.
  • Os campos “Pier-Lote de pagamento” e “Pier-Data de envio lote à Pier”, serão atualizados colocando o id do lote e a data em que o envio foi feito à Pier, respectivamente.

Processando o pagamento do lote

Depois do envio do lote feito no App NavBar, você só precisa aguardar a Pier processar os pagamentos. Quando esse processo finalizar, a Pier atualizará todos tickets enviados no lote, adicionando o status do pagamento e a tag “pier_pagamento_enviado”. Se houver a necessidade de enviar um segundo lote de pagamento logo em seguida, é extremamente recomendado aguardar 5~10 minutos, para que o Zendesk consiga atualizar e remover os tickets do cache. E depois clicar no botão “Recarregar”, para que não ocorra o risco de duplicidade nos dados enviados.

 

Detalhes técnicos

Campos configuráveis do aplicativo

A tabela a seguir exibe os campos configuráveis dos aplicativos e suas funções:

 

Label

Nome

Valor

Função

Lista de usuários que podem acessar o app NavBar

users_that_can_use_navbar

simone.dinis@ontexglobal.com,jefferson.santos@ontexglobal.com,antonia.lima@vermont.com.br,integracoeszendesk@ontexglobal.com

Uma lista de e-mails dos usuário que podem acessar o app NavBar

Base Url Pier

base_url_pier

http://www.pslogistica.com.br:5072/api/

Url base para integração com as APIs da Pier

Id Usuário Pier

pier_user_id

 

Informe o usuário para acessar as APIs da Pier

Chave de acesso Pier

pier_accesss_key

 

Informe a chave de acesso do usuário para usar as APIs da Pier

ID Pier-Valor

id_pier_value

360055886713

Id do campo Pier-Valor, que é preenchido pelo formulário do app sidebar

ID Pier-Banco Lista

id_pier_bank

1500004258242

Id do campo Pier-Banco Lista, que é selecionado pelo formulário do app sidebar

ID Pier-Agência

id_pier_agency

360055886733

Id do campo Pier-Agência, que é preenchido pelo formulário do app sidebar

ID Pier-Conta

id_pier_account

360054885154

Id do campo Pier-Conta, que é preenchido pelo formulário do app sidebar

ID Pier-Data de agendamento

id_pier_scheduling_date

1500001348222

Id do campo Pier-Data de agendamento, que é preenchido quando um pagamento é agendado pelo app sidebar

ID Pier-Data de envio lote à Pier

id_pier_shipment_date

360057355333

Id do campo Pier-Data de envio lote à Pier, que é preenchido quando um lote é enviado à Pier pelo app NavBar

ID Pier-Data de pagamento

id_pier_payment_date

1500001348242

Id do campo Pier-Data de pagamento, que é preenchido pela própria Pier quando o pagamento é processado

ID Pier-Nome Completo

id_pier_full_name

360057501933

Id do campo Pier-Nome Completo, que é preenchido pelo formulário do app sidebar

ID Pier-CPF

id_pier_cpf

360056500614

Id do campo Pier-CPF, que é preenchido pelo formulário do app sidebar

ID Pier-Dígito agência

id_pier_agency_digit

360056500654

Id do campo Pier-Dígito, que é preenchido pelo formulário do app sidebar, caso informado

ID Pier-Dígito conta

id_pier_account_digit

360057501993

Id do campo Pier-Dígito conta, que é preenchido pelo formulário do app sidebar

ID Pier-Tipo de conta

id_pier_account_type

1500001489382

Id do campo Pier-Tipo de conta, que é preenchido pelo formulário do app sidebar

ID Pier-Operação

id_pier_operation

1500001489402

Não foi usado durante o desenvolvimento

ID Pier-Lote de pagamento

id_pier_payment_batch

1500001489462

Esse campo é preenchido quando a Pier retorna o Id do lote pelo app NavBar

ID Pier-Status do pagamento

id_pier_payment_status

1500004753001

Esse campo é preenchido pela própria Pier, quando o pagamento é processado

ID Opções de Ressarcimento

reimbursement_options

360054884954

Esse campo é usado para controlar quando o app sidebar aparece ou não para os operadores, dependendo do valor selecionado

Valor máximo recomendado para app sidebar

recommendend_value

300

Esse campo, é usado para dar um alerta ao operador que estiver usando o app sidebar. Caso informe um valor maior do que 300, uma mensagem será mostrada à ele. O valor pode ser alterado para mais de 300 ou menos

ID Banco

id_pier_bank_field

360054885134

Id do campo Pier-Tipo de conta, que é preenchido pelo formulário do app sidebar

ID Ressarcir consumidor

reimburse_consumer

360055885973

Esse campo também é usado para controlar quando o app sidebar deve aparecer ou não

 

Endpoints

Segue todos os endpoints utilizados nos apps:

1.GET - http://www.pslogistica.com.br:5072/api/Financial/Receipt?${idLote} -> Faz o download do comprovante do lote informado na API da Pier.

 

2.PUT - /api/v2/tickets/${ticketId}/tags -> Insere uma tag no ticket informado.

 

3.PUT - /api/v2/tickets/${ticketId} -> Atualiza o ticket informado.

 

4.GET - /api/v2/ticket_fields/${fieldId} -> Lista as informações referentes ao id do campo informado de um ticket.

 

5.GET - /api/v2/search.json?query=type:ticket tags:${tag} -> Lista todos os tickets que contenha a tag informada.

 

6.PUT - /api/v2/tickets/update_many.json -> Atualiza vários tickets de uma vez separado por jobs.

 

7.PUT - http://www.pslogistica.com.br:5072/api/login -> Faz o login na API da Pier com os dados informados na configuração do app.

 

8.POST - http://www.pslogistica.com.br:5072/api/Financial/Deposit -> Faz a requisição para criar o lote de pagamento na Pier.

 

 

 

Comentários

0 comentário

Por favor, entre para comentar.