Essa documentação trata da integração com o sistema Blip. 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-Blip é do tipo Passiva-direta.
Descrição
O Blip é uma plataforma de criação, publicação e gestão de chatbots, a ferramenta integra diferentes canais de mensageria, como WhatsApp, Instagram e Messenger, apps e sites da empresa, além de CRMs, Bancos de Dados e quaisquer outras ferramentas que possibilitem integração via API.
A integração pode ser configurada de forma personalizada nos fluxos do sistema Blip. Esta documentação exemplifica como pode ser implementada e utilizada a funcionalidade de Consulta de Viabilidade no OZmap para o Blip, porém, muitas outras funcionalidades OZmap podem ser incorporadas nos fluxos Blip utilizando a API OZmap. Consulte a documentação https://ozmap.atlassian.net/l/cp/CKJMvNge para mais informações sobre funcionalidades indicadas.
Resumo de funcionalidades
Funcionalidade | Descrição | Direção da integração |
---|---|---|
Consulta de Viabilidade no OZmap | Consulta de viabilidade de atendimento para clientes no OZmap, através da plataforma de vendas Blip. | OZmap => Blip |
Funcionalidades
Abaixo está descrita a funcionalidade de exemplo, de forma a entender como funciona seu fluxo e como pode ser feita sua implementação no Blip.
Consulta de Viabilidade
A Consulta de Viabilidade realizada pelo Blip no OZmap consiste em verificar a disponibilidade de atendimento para um novo cliente em determinada localidade, e ocorre da seguinte forma:
Para realizar a consulta de viabilidade no OZmap, é necessário dispor das coordenadas do novo cliente. A consulta de viabilidade feita pela API OZmap busca por caixas que não esteja com estado de implantação “Em projeto”, e contenham algum Splitter de atendimento com portas disponíveis;
Com as coordenadas do cliente, basta configurar o fluxo Blip para realizar uma requisição API ao OZmap no momento de verificação de viabilidade, passando as coordenadas do cliente por parâmetro:
https://cliente.ozmap.com.br:9994/api/v2/ftth-viability/radius?lat=-27.57635071150383&lng=-48.52777004241944
O retorno esperado desta requisição é um arquivo json contendo uma lista de todas as caixas encontradas de acordo com as configurações de viabilidade definidas no OZmap, com os seguintes atributos:
viable: Apresenta um valor booleano, indicando se há viabilidade ou não na localização informada;
boxes: Lista de todas as caixas com disponibilidade que foram encontradas no raio de busca, mostrando a distância, número de portas disponíveis, nome da caixa, entre outras informações;
refused_boxes: Lista de caixas que foram encontradas dentro do raio de busca, mas que não possuem disponibilidade para atender clientes no momento.
Adicionalmente, podem ser utilizados mais parâmetros nesta requisição, como por exemplo:
Definir um raio, em metros, para a busca de caixas (
radius
): O raio de busca padrão utilizado na viabilidade é o que estiver definido nas configurações de viabilidade do OZmap, mas pode ser utilizado um raio diferente passando um valor em metros por parâmetro. Exemplo:https://cliente.ozmap.com.br:9994/api/v2/ftth-viability/radius?lat=-27.57635071150383&lng=-48.52777004241944&radius=50
Definir retorno booleano (
return_type=boolean
): Com este parâmetro, o retorno da requisição será um json contendo apenas o atributo “viable", que pode assumir o valor “true” caso haja viabilidade na localidade informada, ou “false” caso não haja viabilidade. Exemplo:https://cliente.ozmap.com.br:9994/api/v2/ftth-viability/radius?lat=-27.57635071150383&lng=-48.52777004241944&return_type=boolean
Dados Acesso
Dados de acesso necessários para as operações realizadas pelo integrador são:
Saiba mais como configurar esses dados acionando o suporte do Blip.
OZmap
Parâmetro | Descrição | Exemplo |
---|---|---|
URL API | Endereço do OZmap, com a porta de serviço padrão. | |
Chave API | 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 |
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 Blip 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 |
---|---|
É possível implementar uma funcionalidade não contemplada pela API OZmap atualmente? | É possível realizamos uma análise da demanda, e sendo viável de implementação, podemos disponibilizar via serviço adicional. Consulte a equipe Comercial do OZmap para mais informações. |
Add Comment