Integrador Umov.me
Integrador Umov.me
Pré requisitos:
- Realizar a configuração da API Cybersul: http://remoto.cybersulinformatica.com.br:8082/books/api-cybersul
Acessando o integrador Umov.me, a mesma não solicitará acesso de usuário e senha para conectar, pois, o mesmo consome dados de conexão com a API CYbersul e API Umov.me.
Conexão
Primeira etapa o integrador conecta com a API Cybersul, deste modo, caso a conexão fique ok, o integrador irá exibir no Painel Central a informação de "Conectado" (Texto em verde), senão exibira o texto "Não Conectado"( Texto em Vermelho)
Segunda etapa, estando conectado com a API Cybersul, a aplicação irá consumir dados da configuração realizada para a Umov.me. Deste modo, a aplicação irá realizar o teste de conexão com a API Umov.me. Caso a conexão fique ok, o integrador irá exibir no Painel Central a informação de "Conectado" (Texto em verde), senão exibira o texto "Não Conectado"( Texto em Vermelho)
Configuração externa
Na aba Configuração Externa, podemos realizar o teste de conexão com a API Umov.me.
Configuração Cybersul
Na aba Configuração Cybersul, podemos realizar o teste de conexão com a API da Cybersul.
Operações
A aba operações possui todas as funcionalidades utilizadas pelo integrador, sendo possível realizar consultas, novos registros e atualizações de forma "manual". Deste modo, as mesmas foram separadas por módulos:
Padrão Força de Vendas
Produto
- GET EXTERNO - ALL: Quando acionado será selecionado todos os produtos na API Umov.me
- GET EXTERNO - BY FILTER: Quando acionado será seleiconado todos os produtos conforme "Campo de Filtro" selecionado.
- Campo de Filtro
- Opções
- Id (Código Umov.me)
- AlternativeIdentifier (Código Cybersul)
- Opções
- Dados do Filtro: Campo para informar o dado que será filtrado
- Campo de Filtro
- POST EXTERNO: Será criado novo cadastro de produto na API Umov.me
- PUT EXTERNO: Será atualizado cadastro de produto na API Umov.me
- GET APICYBERSUL - NOVOS: Será selecionado todos os produtos novos na API Cybersul.
- GET APICYBERSUL - PELO ID: Quando acionado é selecionado produto específico conforme o campo "Código Interno" na API CYBERSUL
- POST APICYBERSUL Registrar Produto: Quando acionado ele cria o registro de integração para o produto Cybersul
- GET APICYBERSUL ATUALIZAR: Quando acionado será selcionado todos os produtos que tiveram modificações após a última da data de integração.
- ABAS
- API EXTERNA: Exibe dados selecionados na API Umov.me
- API CYBERSUL: Exibe dados selecionados na API Cybersul
Cliente
API EXTERNA PARA API CYBERSUL
- GET ALL: Quando acionado será selecionado todos os clientes na API Umov.me
- GET EXTERNO - BY FILTER: Quando acionado será seleiconado todos os produtos conforme "Campo de Filtro" selecionado.
- Campo de Filtro
- Opções
- Id (Código Umov.me)
- AlternativeIdentifier (Código Cybersul)
- Description
- Opções
- Dados do Filtro: Campo para informar o dado que será filtrado
- Campo de Filtro
- POST - APICYBERSUL: Quando acionado será criado novo cadastro de cliente pela API Cybersul
- PUT - APICYBERSUL: Quando acionado será atualizado cadastro de cliente pela API Cybersul
API CYBERSUL PARA API EXTERNA
- GET - APICYBERSUL - PELO CODIGO INTERNO: Será selecionado cliente pela API Cybersul, filtrando pelo Código Cliente (Cybersul).
- GET - APICYBERSUL - PELO CPF: Será selecionado cliente pela API Cybersul conforme campo "Filtro pelo Cpf"
- GET - NOVOS: Será selecionado todos os novos cadastros de clientes.
- POST - NOVOS - API EXTERNA: Quando acionado será criado um novo cadastro de cliente na Umov.me, utilizando os dados do cliente selecionado na Cybersul.
- GET - MODIFICADOS: Quando acionado será selecionado os registros de clientes que otiveram modificação após a data da última integração.
- PUT - MODIFICADOS - API EXTERNA: Quando acionado será realizado procedimento de atualização do cadastro de cliente na Umovme, pelo campo "AlternativeIdentifier" (Informe o código do cliente solution neste campo)
- REGISTRA: Realiza o procedimento de criação de vinculo entre Solution x Umov.me.
Pedido de Venda
GET
- GET - ALL: Quando acionado seleciona todos os pedidos de vendas
- GET - BY FILTER: Quando acionado seleciona os pedidos conforme filtro
- Filtros
- Id: Filtro pelo código da Umov.me
- Situation: Filtro pelo status do pedido, por padrão é sempre utilizado a situação 50 (Retornado de Campo)
- Está situação 50 é indicada pela Umov.me para a seleção de pedidos "Aprovados".
- AlternativeIdentifier: Este campo contém o código do pedido Cybersul na Umov.me
- Um dos motivos de possuir este filtro é devido o integrador possuir recurso para "selecionar" um pedido da Cybersul e criar na Umov.me. Pois quando é criado o pedido na Umov.me deve ser enviado junto o código Cybersul como identificador.
- Filtros
- GET - APICYBERSUL: Quando acionado este botão será selecionado um pedido da cybersul conforme filtro "Código Pedido".
- GET - APICYBERSUL - PELA SITUACAO: Quando acionado este botão, o integrador irá selecionar lista de pedidos conforme o filtro "Situacao".
- O dado que deve ser informado é o código da situação.
- GET APICYBERSUL PARA ATUALIZAR- Quando acionado este botão o integrador irá selecionar todos os pedidos da Cybersul sinalizado como Vendido Internet, que possuem vinculo com pedido externo e que foram editados.
-
- Este recurso pode ser utilizado quando deve ser feito algum update do pedido na Umov.me.
- GET - APICYBERSUL: Quando acionado este botão, será filtro o pedido na Cybersul conforme o código do pedido Umov.me(Externo).
-
- GET - NOVOS - APICYBERSUL: Quando acionado este botão o integrador irá selecionar todos os pedidos da Cybersul sinalizado como Vendido Internet, que não possuem vinculo com pedido externo.
- Este recurso pode ser utilizado quando for criado um novo pedido na Umov.me utilizando os dados da Cybersul.
- GET - MODIFICADOS - APICYBERSUL: Quando acionado este botão o integrador irá selecionar todos os pedidos da Cybersul sinalizado como Vendido Internet, que possuem vinculo com pedido externo, que foram editados e conforme filtro pelo código umovme(externo).
POST
- POST - APICYBERSUL: Quando acionado este botão será criado um novo pedido na Cybersul conforme os dados "selecionados" da guia API EXTERNA.
- POST - APIEXTERNA: Quando acionado este botão será criado um novo pedido na Cybersul conforme os dados "selecionados" da guia API CYBERSUL.
PUT
- PUT - API EXTERNA: Quando acionado este botão será editado pedido na Umov.me conforme os dados "selecionados" da guia API CYBERSUL.
- PUT - API INTERNA: Quando acionado este botão será editado pedido na Cybersul conforme os dados "selecionados" da guia API EXTERNA.
Contato de Entrega
- GET - ALL: Quando acionado, seleciona os dados de cliente na Umov-me porém com formato de "Contato de Entrega".
- GET - BY FILTER: Quando acionado, seleciona os dados de cliente na Umov-me porém com formato de "Contato de Entrega" conforme filtro pela Id do cliente Umov.me.
- Na Umov.me não existe um cadastro "padrão" referente a contato de entrega, deste modo selecionamos do cadastro de cliente.
- POST API CYBERSUL: Quando acionado será criado um contato de entrega conforme os dados selecionados da Umov.me
- PUT - API CYBERSUL: Quando acionado este botão será realizado "Update" nos dados de contato de entrega conforme dados selecionados na Umov.me
- GET - APICYBERSUL - PELO CPF: Quando acionado este botão será selecionado o contato de entrega na Cybersul conforme CPF/CNPJ do cliente.
- Este recurso é utilizado apenas em serviços de sincronização de dados.
- GET - API CYBERSUL - PELA CHAVE ENDEREÇO: quando acionado este botão será selecionado o contato de entrega na Cybersul conforme Endereço, número, complemento, cep, bairro, cidade e estado.
- Este recurso é utilizado apenas em serviços de sincronização de dados.
SUB GRUPO
Na umov.me existe o dado Sub Grupo nos itens, este dado é equivalente ao cadastro de grupos da Cybersul. Este campo é obrigatório nas integrações de pedidos, devido isso, foi criado "procedimentos" para selecionar os sub grupos na Umov.me.
- GET EXTERNO - ALL: Quando acionado este botão, será selecionado todos os regisrtros de sub grupos na Umov.me
- GET EXTERNO - BY FILTER: Quando acionado este botão será selecionado registro de sub grupo na Umov.me conforme filtro.
Integrações Específicas
Na integração com a Umov.me, devido cada cliente possuir sua própria regra de negócio, também podemos ter cadastros específicos, hoje o integradorUmov.me também nos fornecesse suporte a este tipo de modalidade.