Piperun
Essa documentação trata da integração com o sistema Piperun. A integração é realizada através de chamadas de API partindo do Integrador e utilizando a API disponibilizada pelo OZmap.
Tipo de Integração
A integração OZmap-Piperun é do tipo Passiva-direta.
Descrição
O Piperun é uma plataforma de gestão de atendimento focada em estratégias de CS (Customer Success), adequada a qualquer modelo de negócio.
A integração tem como objetivo a consulta de viabilidade com reserva de porta ou criação de prospects no OZmap para o endereço de clientes interessados em contratação via chatbot Piperun.
Resumo de funcionalidades
Funcionalidade | Descrição | Direção da integração |
---|---|---|
Consulta de viabilidade com Reserva de Porta ou criação de Prospect no OZmap | A partir da localização informada pelo cliente no chatbot, o Piperun busca viabilidade no OZmap, podendo realizar a reserva de porta se houver viabilidade ou a criação de um prospect caso não haja viabilidade. | OZmap => Piperun |
Funcionalidades
Abaixo serão descritos alguns exemplos das funcionalidades no resumo de forma a entender como funciona a integração, mas esse processo pode ser customizado pelas configurações do chatbot Piperun.
Consulta de viabilidade com Reserva de Porta ou criação de Prospect no OZmap
A Consulta de viabilidade com Reserva de Porta ou criação de Prospect no OZmap se baseia na busca de viabilidade de atendimento para a localização de um cliente interessado em contratação via chatbot Piperun, e ocorre da seguinte forma:
O cliente começa o processo de contratação pelo chatbot Piperun, onde são dadas duas opções para o cliente enviar a localização onde deseja a instalação para ser verificada viabilidade:
Enviar localização pelo aplicativo: nesta opção, será enviada a localização captada pelo aplicativo que o cliente está usando para interagir com o chatbot (Whatsapp, Telegram, etc);
Procurar minha localização no mapa: o cliente é redirecionado para o FindME (ferramenta OZmap para envio de localização), onde a localização do cliente será captada pelo GPS do dispositivo que o cliente está usando para interagir com o chatbot ou pode ser digitado manualmente o endereço, em ambos os casos é mostrada a localização em imagem de satélite, que pode ser refinada ao arrastar o ícone de local na tela;
Após o envio da localização e confirmação da mesma pelo cliente, o Piperun irá consultar a viabilidade no OZmap, buscando caixas que não estejam “Em projeto”, e possuam splitter de atendimento com portas disponíveis no OZmap;
A busca de viabilidade realizada no OZmap é feita por raio, e a distância máxima para este raio de busca será a que estiver definida nas configurações do OZmap (Configurações > Sistema > API > Raio de busca padrão).
Caso haja viabilidade para a localização informada, o cliente pode optar por realizar a reserva ou não.
Quando for realizada a reserva de porta, será criado um cliente não implantado no OZmap com os dados enviados pelo Piperun, e com drop conectado à caixa mais próxima que tenha dado viabilidade.
Caso não haja viabilidade para a localização, é possível criar um prospect no OZmap, adicionando tags OZmap previamente configuradas no chatbot Piperun.
OBS.: Este fluxo pode ser customizado pelo cliente nas configurações do chatbot Piperun, sendo este um exemplo de fluxo que é possível ser feito.
Dados Acesso
Dados de acesso necessários para as operações realizadas pelo integrador são:
OZmap
Parâmetro | Descrição | Exemplo |
---|---|---|
URL | Endereço do OZmap, com a porta de serviço padrão. | https://cliente.ozmap.com.br:9994/api/v2 |
Token | Token associado a conta do usuário de integração cadastrado no ozmap. (O usuário deve ter acesso aos projetos que a integração irá trabalhar (Escolha do usuário). Tutorial de como gerar usuário/chave.) | eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJtb2R1bGUiOiJhcGkiLCJ1c2VyIjoiNWQ5ZjNmYjgyMDAxNDEwMDA2NDdmNzY4IiwiY3JlYXRpb25EYXRlIjoiMjAyMC0wOC0yNFQxNjoxMjoyMS43MTdaIiwiaWF0IjoxNTk6Mjg1NTQxfQ.S215vbHlBLtZSzxmORIc2sH1lEKi5VALKBqZB1VcFCE |
Saiba mais como configurar esses dados acionando o suporte do Piperun.
Liberação de IPs
Caso o servidor OZmap esteja em ambiente ON-Premisses, é necessário liberar nos firewalls o IP do servidor onde está o Piperun para acessar as portas 80 e 9994 no ambiente do OZmap.
Caso seu servidor seja hospedado pelo OZmap, essas portas já estarão liberadas para o integrador.
Questionário
Pergunta | Resposta |
---|---|
|
|
//Anotar as perguntas e possíveis respostas e quais as funcionalidades relacionadas às respostas.