Integrador Magis5

Integrador Magis5

Pré requisitos:

• Realizar a configuração da API Cybersul: http://remoto.cybersulinformatica.com.br:8082/books/api-cybersul

Neste capítulo, vamos apresentar o IntegradorMagis5 e suas operações. (A imagem abaixo mostra o painel central do integrador).

1. Acessando o integrador magis5, a mesma não solicitará acesso de usuário e senha para conectar, pois, o mesmo
2. consome dados de conexão com a API Cybersul e API Magis5.

3. Conexão

   1. 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)
   2.  Segunda etapa, estando conectado com a API Cybersul, a aplicação irá consumir dados da configuração realizada para a Magis5. Deste modo, a aplicação irá realizar o teste de conexão com a API Magis5. 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 Magis5.

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:

1. Produtos
   1. GET ALL EXTERNO: Quando acionado será selecionado todos os produtos na API Magis5
   2. GET BY FILTER EXTERNO: Quando acionado será selecionado todos os produtos conforme "Campo de Filtro" selecionado.
      1. Campo de Filtro
         1. Opções
            1. Id
      2. Dados do Filtro
   3. POST EXTERNO: Será criado novo cadastro de produto na API Magis5
   4. PUT EXTERNO: Será atualizado cadastro de produto na API Magis5
   5. PUT EXTERNO CODIGOSOLUTION: Quando acionado será atualizado produto na API Magis5 conforme o campo "Código Interno"
   6. GET APICYBERSUL NOVOS ESPECIFICO: Será selecionado todos os produtos novos na API Cybersul, onde está parametrizado com a flag Internet = S
   7. GET APICYBERSUL NOVOS: Será selecionado todos os produtos novos na API Cybersul.
   8. GET APICYBERSUL PELO ID: Quando acionado é selecionado produto específico conforme o campo "Código Interno".
   9. POST APICYBERSUL Registrar Produto: Quando acionado ele cria o registro de integração para o produto Cybersul
   10. GET APICYBERSUL ATUALIZAR: Quando acionado será selecionado todos os produtos que tiveram modificações após a última da data de integração.
   11. ABAS
       1. API EXTERNA: Exibe dados selecionados na API Magis5
       2. API CYBERSUL: Exibe dados selecionados na API Cybersul
2. Clientes
   1. 
   2. GET ALL: Seleciona todos os clientes na Magis5
   3. GET BY FILTER: Seleciona um cliente específico, conforme Campo de Filtro
      1. Campo de Filtro
         1. Opções
            1. Id do Pedido
            2. Status do Pedido
            3. dateCreated do Pedido
      2. Dados do Filtro
   4. POST APICYBERSUL: Cria um novo cadastro de cliente na Cybersul
   5. PUT APICYBERSUL: Atualiza um cadastro de cliente na Cybersul
   6. GET APICYBERSUL PELO CPF: Seleciona um um cliente da Cybersul pelo CPF.
   7. Observação: O cliente é selecionado dos dados do Pedido de Venda.
3. Pedidos
   
   1. ABA GET
      1. GET ALL API EXTERNA: Seleciona todos os pedidos na API Magis5.
      2. GET BY FILTER API EXTERNA: Seleciona os pedidos conforme Filtro
         1. Campo de Filtro
            1. Opções
               1. Id
               2. Status
               3. dateCreated
         2. Dados do Filtro
         3. Tipo Pedido
            1. Opções 
               1. Pedido Faturado
               2. Pedido Não Faturado
               3. Todos
      3. GET APICYBERSUL: Com está opção é possível selecionar o pedido na API Cybersul pelo "Codigo Pedido"
      4. GET APICYBERSUL: Com está opção é possível selecionar pedidos na API Cybersul pelo "Código Pedido Externo"
      5. GET APICYBERSUL RESUMIDO: Com está opção é possível selecionar o pedido na API Cybersul pelo "Código Pedido Externo", porém, o retorno dos dados conterá menos campos, aumentando a performance da seleção. 
   2. ABA POST
      1. 
      2. POST API CYBERSUL: Com está opção é realizado o cadastro de novo pedido na API Cybersul.
   3. ABA PUT
      1. 
      2. PUT APICYBERSUL FATURADO INTEGRADO: Com está opção é possível realizar a atualização da situação do Pedido de Venda
      3. Observação: Alguns clientes não utilizam está opção, portanto, a mesma pode estar "invisível".
4. Contato
   1. 
   2. GET ALL: Seleciona todos os Contatso de Entrega na Magis5
   3. GET BY FILTRO
      1. Campo de Filtro
         1. Opções
            1. Id do Pedido
            2. Status do Pedido
            3. dateCreated do Pedido
      2. Dados do Filtro
   4. POST APICYBERSUL: Cria um novo cadastro de contato de entrega na API CYBERSUL
   5. PUT APICYBERSUL: Atualiza um cadastro de contato de entrega na API CYBERSUL
   6. GET APICYBERSUL PELO CPF: Filtra um Contato de Entrega Pelo CPF na API Cybersul
   7. GET APICYBERSUL PELA CHAVE ENDEREÇO: Filtra um contato de Entrega pelo Endereço, Número, Complemento, Cep, Bairro, Cidade, Estado.
      1. Observação: Deve ser informado todos os campos para realizar o filtro.
5. Análise Integração
   
   1. Está tela foi adicionada para analisar os pedidos que foram integrados.
   2. Ela permite filtrar:
      1. Data Início
      2. Data Fim
      3. Filial: Informe o nome da EMPRESA, por padrão já vem informado com a filial que foi configurada no integrador.
      4. MarketPlace: pode ser informado o nome do marketplace para filtro
      5. Tipo Pedido
         1. Opções 
            1. Pedido Faturado
            2. Pedido Não Faturado
            3. Todos
   3. Aba
      1. Listagem
         1. Exibe a seleção dos dados de pedidos
      2. Resumo
         1. Exibe descrição contendo o resultado quantitativo por dia.