Integrador Umov.me

Integrador Umov.me

Pré requisitos:

  • Realizar a configuração da API Cybersul: http://remoto.cybersulinformatica.com.br:8082/books/api-cybersul
Neste capítulo, vamos apresentar o IntegradorUmovme e suas operações. (A imagem abaixo mostra o painel central do integrador).
imagem-1.JPG

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

imagem-2.JPG

Na aba Configuração Externa, podemos realizar o teste de conexão com a API Umov.me.

Configuração Cybersul

imagem-3.JPG

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

image-1721052272111.png

  1. GET EXTERNO - ALL: Quando acionado será selecionado todos os produtos na API Umov.me
  2. GET EXTERNO - BY FILTER: Quando acionado será seleiconado todos os produtos conforme "Campo de Filtro" selecionado.
    1. Campo de Filtro
      1. Opções
        1. Id (Código Umov.me)
        2. AlternativeIdentifier (Código Cybersul)
    2. Dados do Filtro: Campo para informar o dado que será filtrado
  3. POST EXTERNO: Será criado novo cadastro de produto na API Umov.me
  4. PUT EXTERNO: Será atualizado cadastro de produto na API Umov.me
  5. GET APICYBERSUL - NOVOS: Será selecionado todos os produtos novos na API Cybersul.
  6. GET APICYBERSUL - PELO ID: Quando acionado é selecionado produto específico conforme o campo "Código Interno" na API CYBERSUL
  7. POST APICYBERSUL Registrar Produto: Quando acionado ele cria o registro de integração para o produto Cybersul
  8. GET APICYBERSUL ATUALIZAR: Quando acionado será selcionado todos os produtos que tiveram modificações após a última da data de integração.
  9. ABAS
    1. API EXTERNA: Exibe dados selecionados na API Umov.me
    2. API CYBERSUL: Exibe dados selecionados na API Cybersul

Cliente

API EXTERNA PARA API CYBERSUL

image-1721054006187.jpg

 

  1. GET ALL: Quando acionado será selecionado todos os clientes na API Umov.me
  2. GET EXTERNO - BY FILTER: Quando acionado será seleiconado todos os produtos conforme "Campo de Filtro" selecionado.
    1. Campo de Filtro
      1. Opções
        1. Id (Código Umov.me)
        2. AlternativeIdentifier (Código Cybersul)
        3. Description
    2. Dados do Filtro: Campo para informar o dado que será filtrado
  3. POST - APICYBERSUL: Quando acionado será criado novo cadastro de cliente pela API Cybersul
  4. PUT - APICYBERSUL: Quando acionado será atualizado cadastro de cliente pela API Cybersul

API CYBERSUL PARA API EXTERNA

image-1721054541260.png

  1. GET - APICYBERSUL - PELO CODIGO INTERNO: Será selecionado cliente pela API Cybersul, filtrando pelo Código Cliente (Cybersul).
  2. GET - APICYBERSUL - PELO CPF: Será selecionado cliente pela API Cybersul conforme campo "Filtro pelo Cpf" 
  3. GET - NOVOS: Será selecionado todos os novos cadastros de clientes.
  4. POST - NOVOS - API EXTERNA: Quando acionado será criado um novo cadastro de cliente na Umov.me, utilizando os dados do cliente selecionado na Cybersul.
  5. GET - MODIFICADOS: Quando acionado será selecionado os registros de clientes que otiveram modificação após a data da última integração.
  6. 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) 
  7. REGISTRA: Realiza o procedimento de criação de vinculo entre Solution x Umov.me.

Pedido de Venda

GET

EzOpedido-GET.JPG

  1. GET - ALL: Quando acionado seleciona todos os pedidos de vendas
  2. GET - BY FILTER: Quando acionado seleciona os pedidos conforme filtro
    1. Filtros
      1. Id: Filtro pelo código da Umov.me
      2. Situation: Filtro pelo status do pedido, por padrão é sempre utilizado a situação 50 (Retornado de Campo)
        1. Está situação 50 é indicada pela Umov.me para a seleção de pedidos "Aprovados".
      3. AlternativeIdentifier: Este campo contém o código do pedido Cybersul na Umov.me
        1. 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.
  3. GET - APICYBERSUL: Quando acionado este botão será selecionado um pedido da cybersul conforme filtro "Código Pedido".
  4. GET - APICYBERSUL - PELA SITUACAO: Quando acionado este botão, o integrador irá selecionar lista de pedidos conforme o filtro "Situacao".
    1. O dado que deve ser informado é o código da situação.
  5. 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. 
      1.  Este recurso pode ser utilizado quando deve ser feito algum update do pedido na Umov.me.
    1. GET - APICYBERSUL: Quando acionado este botão, será filtro o pedido na Cybersul conforme o código do pedido Umov.me(Externo).
  6. 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.
    1. Este recurso pode ser utilizado quando for criado um novo pedido na Umov.me utilizando os dados da Cybersul.
    2. 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

pedido-POST.JPG

  1. POST - APICYBERSUL: Quando acionado este botão será criado um novo pedido na Cybersul conforme os dados "selecionados" da guia API EXTERNA.
  2. POST - APIEXTERNA: Quando acionado este botão será criado um novo pedido na Cybersul conforme os dados "selecionados" da guia API CYBERSUL.

PUT

PEDIDO-put.JPG

  1. PUT - API EXTERNA: Quando acionado este botão será editado pedido na Umov.me conforme os dados "selecionados" da guia API CYBERSUL.
  2. PUT - API INTERNA: Quando acionado este botão será editado pedido na Cybersul conforme os dados "selecionados" da guia API EXTERNA.

Contato de Entrega

contato.JPG

  1. GET - ALL: Quando acionado, seleciona os dados de cliente na Umov-me porém com formato de "Contato de Entrega".
  2. 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.
    1. Na Umov.me não existe um cadastro "padrão" referente a contato de entrega, deste modo selecionamos do cadastro de cliente.
  3. POST API CYBERSUL: Quando acionado será criado um contato de entrega conforme os dados selecionados da Umov.me
  4. PUT - API CYBERSUL: Quando acionado este botão será realizado "Update" nos dados de contato de entrega conforme dados selecionados na Umov.me
  5. GET - APICYBERSUL - PELO CPF: Quando acionado este botão será selecionado o contato de entrega na Cybersul conforme CPF/CNPJ do cliente.
    1. Este recurso é utilizado apenas em serviços de sincronização de dados.
  6. 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.
    1. 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.

SUBGRUPO.JPG

  1. GET EXTERNO - ALL: Quando acionado este botão, será selecionado todos os regisrtros de sub grupos na Umov.me 
  2. 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.