WSH - Winthor Smart Hub - Integrações

Clique no botão Novo, (será apresentado os dados para Cadastro de Integração);

 Cadastro de Integração nova

Tela destinada ao cadastro de uma nova integração:

• •  Código - Campo que apresentará o ID único do cadastro, este campo é gerado automaticamente.
  • Nome - Deverá ser informado o nome da integração para identificação da mesma.
  • URL Sistema Externo - Deverá ser informada a URL da API que será usada na integração externa.
  • Utiliza WTA - Deverá ser informado se será utilizado como processo WTA (Sim ou Não ).
  • Filial - Deverá ser selecionado o nome da filial.
  • Tempo de expiração - Deve ser informado o tempo (em segundos) para expiração do token. 
  • Token - Este campo será gerado automaticamente após a criação da Integração
  • Botão Salvar - Salva os dados adicionados.

Para adicionar uma nova validação, basta rolar a tela até o final e preencher as informações desejadas:

Tipo: Tipo da validação (serviço ou parâmetro);

Em caso de Serviço:

• Preencher o nome do serviço (Ex.: winthor-produto);
• Preencher a versão mínima esperada. Caso o requisito seja apenas que o serviço esteja instalado. pode deixar o campo em branco;
• Os campos Filial e Permite nulo não precisaram ser usados nesse cenário;

Em caso de Parâmetro:

• Preencher o nome do parâmetro (Ex.: CON_UTILIZAVENDAPOREMBALAGEM)
• Preencher o valor esperado:
  • OBS1: tratar valores booleanos como S (verdadeiro) e N (falso);
  • OBS2: caso o requisito seja apenas que o parâmetro esteja preenchido com algum valor, deixar o campo vazio e desmarcar a opção "Permite nulo?" ao lado;
• Preencher a filial do parâmetro. Caso seja um parâmetro geral, deixar o campo vazio ou preencher com filial 99;
• Caso o parâmetro deva necessariamente estar preenchido com alguma informação, desmarcar a opção "Permite nulo?";

Adicionar: O botão "Adicionar" levará o registro para a tabela de cima, com a situação igual a "Pendente", ou seja, aguardando validação;

Para realizar a validação, basta clicar no botão "Validar"

Exemplo:

Selecione a opção Rotas no Menu;

Clique no botão Novo, (será apresentado os dados para Cadastro de Rota/Serviço);

 Cadastro de Rota/Serviço 

Tela destinada ao cadastro de uma nova rota

• •  Código - Campo que apresentará o ID único do cadastro, este campo é gerado automaticamente.
  • ID Integração - Deverá ser informado a empresa da rota que executará a ação.
  • Descrição da Integração - Ao selecionar o ID da empresa o nome será apresentado conforme cadastrado no banco de dados.
  • Status - O status ele define se a própria rota que tá sendo criada vai ser executada ou não. Deverá selecionar uma das opções ATIVO(será executada) / INATIVO(não será executada).
  • Autenticador -  Deverá selecionar as opções SIM/NÃO. Caso a Rota precise de autenticação antes da execução, este campo deverá ser informado igual a SIM, caso contrário informar NÃO.
  • Atualizar Token - Deverá selecionar as opções SIM/NÃO. Caso a Rota precise ATUALIZAR o Token, este campo deverá ser informado igual a SIM, caso contrário informar NÃO.
  • Nome do Serviço - É o nome que o usuário pode dar à rota pra identificá-la depois.

 Cadastro de Rota/Serviço 

Tela destinada ao cadastro de uma nova rota

• • Nome do Serviço / Nome Layout - É o nome que o usuário pode dar ao layout pra identificá-la depois.
  • Método HTTP - É o método que será utilizado pelo layout (GET, POST, PUT, DELETE, PATCH).
  • URL - A url a qual o layout irá utilizar.
  • Query -  Query utilizada no layout para realizar as consultas necessárias conforme configurações desejadas.
  • Body - Irá preencher o bodyraw do JSON
  • Parâmetros de Header - Permite adicionar novos parâmetros ao JSON do layut

• • Layout de Comunicação - Campo destinado a inserção do Layout que faça comunicação com o serviço, deve-se indicar o tipo de requisição e parâmetros necessários para que a ação seja executada, conforme o exemplo abaixo:

{
  "name": "",
  "request": {
    "method": "",
    "header": [],
    "url": {
      "raw": "",
      "query": ""
    },
    "bodyraw": ""
  },
  "response": []
}

Ao finalizar o Cadastro de layout de comunicação de Rota/Serviço, será apresentado o botão "Próximo" que levará ao segundo passo de configuração, Layout de Transformação.

• O layout de transformação é dividido em 4 partes que são:
  • JSON de entrada - Campo destinado a adição de como receber a informação.

• JSON de Saída - Campo destinado a informação de como deve ficar o JSON final do processo.

• Mapear JSON - está no centro das informações JSON de entrada e JSON de Saída, este campo é responsável por configurar o que liga os campos de entrada e saída para gerar o JSON de transformação do processo.

• Layout de Transformação - Campo destinado a inserção do Layout que faça transformação dos dados recebidos de forma que o ERP Winthor consiga integrar. Ao clicar no botão "Gerar Layout" será gerado dinamicamente após preenchimento das informações JSON entrada/saída e mapeamento dos campos,

[
  {
    "operation": "shift",
    "spec": {
      "id": "idExterno[0]",
      "shipment": { "logistic_type": "ignorarImportacaoDiferente(regra)" }
    }
  }
]

• Botão Salvar - Salva os dados adicionados.

Clique no botão Novo, (será apresentado os dados para Cadastro de parâmetro);

Cadastro de Parâmetro

Tela destinada ao cadastro de um novo parâmetro;

• • Código - Campo que apresentará o ID único do cadastro, este campo é gerado automaticamente.
  • ID Rota Serviço- Deverá ser informado o ID da rota para qual o parâmetro será vinculado.
  • Global- Ao selecionar o checkbox Global, será utilizado a rota global ao invés de alguma outra selecionada (Ao selecionar a Global, a seleção de ID Rota Serviço fica desabilitada).
  • Tipo Chave - Deverá selecionar o tipo da chave que será utilizada, se vai ser um parâmetro de BODY, PARAMS ou HEADER.
  • Chave - Será o nome do parâmetro.
  • Tipo Valor -  Informação que identifica de qual natureza é o valor, pode ser uma STRING pura, um SELECT no banco ou um ENCRYPTED, um valor que armazena codificado.
    
  • Valor - Deverá informar o valor referente ao campo.
  • Botão Salvar - Salva os dados adicionados.

Abaixo um exemplo de cadastro:

Clique no botão Novo, (será apresentado os dados para Cadastro de fluxos);

Cadastro de fluxos

Nesta tela deverá ser informado o nome(descrição) do fluxo a ser criado e selecionar uma integração;

Cadastro de fluxos

Nesta dela, podemos montar os fluxos de acordo com o necessário simplesmente selecionando no lado esquerdo o fluxo necessário e arrastando para a tela em branco da direita.

Caso tenham vários fluxos já adicionados, e a ordem não esteja de acordo com o esperado, podemos mover os fluxos já adicionados entre eles, também arrastando os mesmos com o mouse.

Temos uma lista com vários recursos que podem ser utilizados:

AutenticadorRefreshTokenApi =

BuscaRotaServicoNaoPaginada =

BuscaRotaServicoPaginada =

CriaVariavelTemporaria =

FinalizaVariavelTemporaria =

PersisteIntegracao =

EnvioIntegracaoStatusRecebido =

EnvioIntegracaoStatusEmProcessamento =

ConsultarStatusPosIntegracao =

EnvioIntegracaoStatusRecebidoLote =

Após adicionar os itens que forem necessários, podemos ir para a Seleção de rotas clicando em próximo passo;

Neste passo, devemos vincular as rotas em cada fluxo que foi adicionar, clicando na lupa para realizar a busca da rota;

Após clicar na lupa, devemos procurar a rota necessária de acordo com o fluxo, como no exemplo abaixo, buscamos a rota de autenticação para o fluxo de AutenticadorRefreshTokenApi;

1º Buscando a rota digitando pelo nome, ou listando as mesmas sem a necessidade de digitar;

2º Clicar sobre a rota para selecionar a mesma;

3º Confirmar a rota selecionada.

Após selecionar as rotas para cada fluxo podemos ir para a revisão dos dados ou em caso de necessidade, podemos voltar um passo para selecionar ou remover outro item no fluxo voltando a página anterior;

Ao chegar no último passo, o passo de revisão, podemos ficará ativo ou não, também definir IDs independentes e também podemos alterar novamente a ordem de cada item arrastando os mesmos para cima e para baixo.

Obs: No caso de alterar a ordem, podemos verificar que o primeiro item da tabela, "Ordem de execução" também irá alterar, respeitando a ordem de cima para baixo.

Ativar ou desativar o fluxo, irá definir se o fluxo vai ficar operante ou não;

A informação do ID independente serve para informar se uma rota depende da execução de outra para funcionar.

Ex: Se for necessário enviar uma requisição pro WTA, vai precisar fazer o login antes, então a rota que comunica com o WTA é dependente de uma rota de login que o usuário precisa definir no cadastro do fluxo

Ao clicar em concluir o fluxo é salvo.

Na tela dos detalhes técnicos, podemos realizar as devidas consultas podendo filtrar as mesmas por período de data, por rota, por status sendo esses apenas um ou múltiplos e também controlar a quantidade itens exibidos por página.

Na tela inicial do cadastro de de/para, temos uma visualização geral dos itens já cadastrados, e também podemos utilizar os filtros para uma melhor visualização dos dados de interesse.

Cadastro de novo item

Para cadastrar um novo item de de/para, basta clicar em novo e informar os campos solicitados:

Neste exemplo usamos a tabela de produtos(PCPRODUT) para cadastrar um código alternativo para um produto:

Após preencher todos os dados, basta salvar e depois em confirmar:

Então o novo item já deve aparecer salvo na coluna de exibição:

Edição de itens

Para editar um item de de/para, basta clicar no botão de contexto (...) e editar o item que desejar:

Os dados devem vir carregados com as informações já existentes:

Basta editar o item que desejar e salvar.

Neste caso vamos apenas mudar o código externo para exemplificar:

Após salvar, o item deve estar atualizado na listagem:

Exclusão de itens

Para excluir um item de de/para, basta clicar no botão de contexto (...) e excluir o item que desejar (esta alteração é Irreversível):

Após clicar em excluir, é necessário confirmar a exclusão:

Após confirmar, um toast de confirmação será exibido informando que o item foi excluído, e o mesmo não irá mais aparecer na listagem:

Na tela inicial da seção de Transformação de Layouts temos já os campos destinados a realizar a validação de nossos layouts.

Nesta tela temos 3 campos, sendo eles;

Json de entrada: Neste campo, devemos inserir o json que queremos transformar;

Layout: Neste campo, devemos inserir o Json, que será responsável pela transformação, ou seja, o próprio layout de transformação;

Resultado/erros: Neste campo, será apresentado  o resultado da transformação, no caso de sucesso, será informado um Json com o resultado da transformação, e em caso de erro, será exibido o erro que ocorreu brevemente.

Também é possível clicar nos botões de Validar Json de Entrada e Validar Json Layout, para que seja realizado uma validação do Json antes de transformar.

Exemplificando o uso, abaixo, a demonstração de uma transformação de exemplo;

Json de Entrada:

Json de entrada:

{
  "rating": {
    "primary": {
      "value": 3
    },
    "quality": {
      "value": 3
    }
  }
}

Json do Layout: 

 [
  {
    "operation": "shift",
    "spec": {
      "rating": {
        "primary": {
          "value": "Rating",
          "max": "RatingRange"
        },
        "*": {
          "max":   "SecondaryRatings.&1.Range",
          "value": "SecondaryRatings.&1.Value",
          "$": "SecondaryRatings.&1.Id"
        }
      }
    }
  },
  {
    "operation": "default",
    "spec": {
      "Range": 5,
      "SecondaryRatings": {
        "*": {
          "Range": 5
        }
      }
    }
  }
]

Resultado: 

Neste caso, um exemplo onde ocorreu sucesso na transformação, o resultado é um Json com os dados transformados;

{
  "Rating": 3,
  "SecondaryRatings": {
    "quality": {
      "Id": "quality",
      "Value": 3,
      "Range": 5
    }
  },
  "Range": 5
}