Hubsoft

Essa documentação trata da integração com o sistema Hubsoft. A integração é realizada atraves de chamadas de API partindo do Integrador e utilizando a API disponibilizada pelo OZmap.

Tipo de Integração

A integração OZmap-Hubsoft é do tipo Passiva-direta.

Descrição

O Hubsoft é um sistema de Gestão (ERP) focado no controle financeiro, OLTs, estoque e documentação para Provedores de internet.

Resumo de funcionalidades

Funcionalidade	Descrição	Direção da integração
Sincronização de elementos	Sincronização de Caixas/Splitters e Postes desenhados no OZmap, para o Hubsoft	OZmap => Hubsoft
Criação de clientes	Criação de clientes no OZmap, com base nos clientes associados a portas de splitter no Hubsoft.	Hubsoft => OZmap
Atualização de porta a cliente	Replica a informação de caixa/porta do cliente ao OZmap, quando atualizado no Hubsoft.	Hubsoft => OZmap
Cancelamento de serviço	Remover cliente do OZmap quando cliente é cancelado no Hubsoft. (Apenas quando finalizada O.S. de retirada)	Hubsoft => OZmap

Funcionalidades

Abaixo serão descritas as funcionalidades apresentadas no resumo de forma a entender como funciona o fluxo de sincronização.

Para informações mais detalhadas, consulte a documentação do Hubsoft.

Sincronização de elementos

A sincronização consiste na busca de caixa/splitters/postes presentes no OZmap pelo Hubsoft, e criação/atualização/remoção dos mesmos na estrutura de dados do Hubsoft.

A sincronização ocorre todos os dias as 04:00 AM.
Postes podem ser ignorados pelo cliente nas configurações do Hubsoft
Caixas e Splitters são obrigatórios.

Criação de clientes

Criação de clientes no OZmap, com base na leitura de clientes associados a portas de splitter no Hubsoft.

Quando um cliente é associado a uma porta de splitter no Hubsoft, o mesmo verifica se esse cliente já existe no OZmap;
Se o cliente não existir no OZmap, a integração cria o cliente no OZmap cam base nos dados deste cliente Hubsoft.

Atualização de porta a cliente

Atualização da porta do cliente no OZmap, com base em modificações realizadas no Hubsoft nas seguintes funcionalidades.

Atualização de splitters/porta dentro das informações do cliente;
Atualização de clientes dentro da tela de caixas/splitters;

Cancelamento de serviço

Remoção de cliente no OZmap quando o serviço relacionado a ele é cancelado no Hubsoft:

Para que o cancelamento seja enviado ao OZmap, é necessário que seja aberta uma OS de retirada de equipamentos;
Cliente é removido no OZmap assim que a OS for finalizada.

Dados Acesso

Dados de acesso necessários para as operações realizadas pelo integrador são:

Saiba mais como configurar esses dados utilizando a documentação do Hubsoft.

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

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 Hubsoft 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
No Hubsoft aparece para colocar Login e Senha, é necessário também?	Não, você pode apenas colocar o Token, que irá funcionar corretamente, login e senha não precisa ser utilizado
O vinculo entre clientes Hubsoft e OZmap é feito por qual campo?	O campo que faz o vínculo entre clientes Hubsoft e OZmap é o idservico.

//Anotar as perguntas e possíveis respostas e quais as funcionalidades relacionadas às respostas.