Logística - TOTVS WMS (SAAS) - WMS - Métodos de compartilhamento de dados SaaS

Tempo aproximado para leitura: 00:08:40 min

Dúvida
Quais os Métodos de compartilhamento de dados Saas?

Ambiente
TOTVS Logística - TOTVS WMS (SAAS) - Integração - Todas as versões

Solução
Os produtos SaaS possuem a responsabilidade de manter os dados seguros e imutáveis por comandos diretos que não passam pela estrutura do produto.

Isto garante que os dados sempre são confiáveis, validados, e mais importante cumprindo as regras legais da LGPD.

Contudo, por diversas vezes, os clientes necessitam ter acesso aos dados do sistema por diversos motivos. Alguns precisam disparar procedimentos internos baseados em dados do sistema, outros precisam customizar pesquisas juntando informações dos produtos SaaS com outros sistemas. Outros ainda precisam somente consultar estes dados via software.

Para isto temos 3 formas diferentes de consultar informações dos produtos da Suíte Logística, seguem as formas:

• API
• Webhook
• Data Sharing

Cada uma das formas se aplicam para requisitos diferentes. Vamos entender como cada uma funciona para depois exemplificar o uso de cada uma delas.

API -  são o método mais comum de acesso. Através de um token M2M gerado dentro do ambiente de administração da Suíte Logística, você pode utilizar APIs GET para consultar informações do sistema. As APIs que podem ser utilizadas, são APIs na versão “externa”, pois estas são APIs com versão mais prolongada, garantindo mais tempo sem necessidade de atualização. Estas APIs também podem sofrer depreciação e entrarem em descontinuidade, mas avisos são enviados indicando a versão mais atualizada. Esta forma de consultar informações do SaaS é orientada ao consumo, isto é, combina informações descritivas e códigos das informações.

Se a API desejada não existe em sua versão externa, entre em contato com o nosso atendimento para abrir uma requisição para o produto.

Webhook -  é uma ferramenta da estrutura SaaS da Totvs. Ela proporciona que o cliente consiga ser avisado no exato momento que alguma ação é executada no sistema.

O método de aviso é o acionamento de uma API que você cadastra e informa qual evento deve ser propagado. Neste acionamento a API cadastrada irá receber todos os dados que constam neste evento.

Os produtos da Suíte Logística possuem arquitetura orientada a eventos. Isto quer dizer que, tudo o que ocorre no sistema tem um evento sendo disparado na mensageria. Um exemplo, você faz um cadastro de um novo produto, um evento é disparado, um cadastro de um produto é alterado, um novo evento é disparado. 

Então o que o Webhook faz é propagar esta informação no modelo json diretamente para a API cadastrada. O serviço tentará algumas vezes o envio para a API, caso não consiga, ainda possui uma lista de mensagens que não foram ainda enviadas corretamente para a API que se chama dead letter. Desta forma mesmo o sistema do cliente estando fora do ar, informações não se perderão.

Data Sharing -  é o serviço de compartilhamento dos dados dos bancos de dados dos produtos.
Ele funciona como um espelhamento lógico das tabelas diretamente para um banco BigQuery contratado pelo cliente. O cliente contrata diretamente com o Google o BigQuery e nos passa a informação de sua conta. Nós compartilhamos as tabelas do produto com a sua conta e após isso o cliente passa a ter acesso a um espelho dos dados em near-real time no seu banco de dados.

Esta funcionalidade dará acesso completo ao modelo de dados e todos os dados do produto do seu tenant. Não é possível modificar, excluir ou inserir dados. O espelhamento também não é feito diretamente no banco de dados de execução do produto, ele é feito através do banco de dados dos Insights logísticos.

A solução para cada problema

Vamos agora listar possíveis situações com a melhor estratégia de solução utilizando nossas ferramentas de compartilhamento de dados.

1- Consulta pontual de um estoque do WMS

Neste caso, a solução mais indicada é a consulta por API externa. 

Porque escolhemos a API? Porque a consulta não é constante e precisamos somente consultar o estoque. A API atende demandas pontuais de consulta e já proporciona o dado orientado ao consumo código e valor.

2- Consulta do status de um processo do produto YMS.

Para esta necessidade, a consulta de uma API associada ao uso do Webhook é a solução perfeita.

Usamos a API para saber qual é o código interno de um processo. Após isso, usando o Webhook e assinando as modificações de status deste processo, o cliente passará a receber atualizações do processo no momento que foram realizados sem precisar realizar consultas constantes a cada X tempo para saber se o status mudou.

3- Consultar quantos processos de recebimento estão em execução no momento no WMS.

Via API é a melhor alternativa. A consulta será realizada e trará a situação atual dos recebimentos. Neste caso não é necessário nem ter guardado as informações localmente para tirar processos cancelados ou finalizados. Somente a consulta na API basta.

4- Gerar um relatório para cada Checklist finalizado.

Webhook e APIs resolverão o problema. Via Webhook você fará a assinatura dos eventos de encerramento de Checklist e utilizando as APIs buscará informações adicionais para a montagem do relatório.

5- Montagem de KPIs e Dashs em conjunto com dados locais em um BI próprio

Para esta situação indicamos o Data Sharing. Ele é abrangente e compreenderá todas as principais informações do produto. Ao acessar o banco de dados espelho o cliente poderá exportar, montar views etc para tratar os dados dos produtos da Suíte e unificar com suas informações locais para montar as visões.

6- Montar planilha com dados dos agendamentos para enviar para um terceiro

Insights logísticos é a resposta. Este é o ambiente perfeito para a montagem de análises customizadas e visões. A informação pode ser exportada.

7- Montar uma série de customizados para utilizar dados dos produtos para diversas frentes do cliente. Cliente de grande porte com TI dedicada.

Data Sharing é a solução ideal para grandes clientes com muitos customizados que desejam ter liberdade para acessar qualquer informação e consumir à vontade os seus dados.

8- Obter dados de todos os veículos que passaram na portaria near-real time para uso em outra aplicação

O Webhook é o caminho ideal para este tipo de requisito. Assinar o evento para receber a cada passagem pelo ponto de controle de portaria no exato momento que ocorre. Após isso é só gravar a informação e utilizar em outro sistema.
 

Glossário
API -  Application Programming Interface, que em português significa Interface de Programação de Aplicações;
YMS - Yard Management System;

Saiba mais

Orientações sobre como utilizar o client-id e o client-secret para gerar autorização de comunicação com os produtos TOTVS SaaS: Logística - TOTVS Checklist - Checklist - Orientações para integração com produtos TOTVS SaaS via API

Como gerar as credenciais de Clientes OAuth para comunicação M2M - Machine to Machine para integrações com os produtos TOTVS SaaS: Logística - TOTVS Checklist - Checklist - Como gerar as credenciais de Clientes OAuth para integrações com os produtos TOTVS SaaS