[WiP] Matrix

Essa documentação trata da integração com o sistema Matrix. 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-Matrix é do tipo Passiva-direta.

Descrição

A Matrix é uma plataforma que permite a criação, publicação e gestão de chatbots. Essa ferramenta integra diferentes canais de mensageria, como WhatsApp, Instagram e Messenger, entre outros.

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 do chatbot Matrix.	OZmap => Matrix

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 Matrix.

Consulta de Viabilidade

A Consulta de Viabilidade realizada pelo Matrix no OZmap consiste em verificar a disponibilidade de atendimento para um novo cliente em determinada localidade, e ocorre da seguinte forma:

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 Matrix.

OZmap

Parâmetro	Descrição	Exemplo
URL API	Endereço do OZmap, com a porta de serviço padrão.	https://cliente.ozmap.com.br:9994/api/v2
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 Matrix 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.