Extração de dados M2
Objetivo
O objetivo da extração de dados é simplificar a integração com outras aplicações, proporcionando um ambiente controlado que facilite a busca eficiente das informações contidas no M2. Com essa abordagem, todos os relatórios disponíveis no sistema se tornarão fontes de dados potenciais para a extração das informações necessárias. Dessa forma, busca-se otimizar a utilização dos dados do sistema, permitindo maior flexibilidade e agilidade nas análises e processos das aplicações integradas.
Funcionalidades
Autenticação
O mecanismo de autenticação é baseado em tokens, que são gerados pela empresa utilizando o sistema M2. Para obter o token de acesso, é necessário entrar em contato com o responsável pela área de Tecnologia da Informação (TI) da empresa que utiliza o M2. Durante qualquer operação na API, o token deve ser enviado no cabeçalho (header) da solicitação HTTP, utilizando a key "use-relatorio-token", para garantir a autenticação adequada.
Para gerar o token, é necessário acessar o Sistema Useall > Módulo Central > Usuários > Selecionar o usuário para gerar o Token > Mais opções > Token de Acesso relatório.
Atenção
Ao receber os tokens de acesso, deve-se guardá-los em segurança para garantir que ninguém fora da empresa tenha acesso aos dados.
Extraindo dados
A busca de informações do M2 é feita através de requisição HTTP(GET), os dados são enviados e recebidos no formato JSON. É possível desenvolver a integração em qualquer linguagem de programação, desde que tenha-se bibliotecas para conexão HTTP e bibliotecas para leitura e escrita de dados no formato JSON.
A consulta permite a busca de vários dados, sendo que qualquer relatório disponível no sistema é considerado uma fonte de dados.
Para realizar a busca das informações, é necessário obter a identificação e os filtros do relatório. Para isso deve-se seguir os seguintes passos:
Após a captura da identificação, é essencial verificar se o relatório possui parâmetros necessários para a execução.
Para realizar essa verificação, é preciso acessar o relatório para obter essas informações:
para abrir a tela do relatório > Aba SQL > Copiar o SQL.
Após a coleta das informações, deve-se fazer um GET na seguinte URL: https://query.useallcloud.com.br/api/v2/RelatorioExterno/executarexportarjson?Identificacao=Identificação do relatório&FiltrosSqlQuery=[parametros encontrados]
Objeto a ser passado como parâmetro no 'FiltrosSqlQuery'
Um exemplo que ilustra a execução da consulta mencionada anteriormente:
Esses parâmetros são essenciais para atender às necessidades do relatório "m2_vendas_analise_abc_de_pedido_por_cidade", conforme ilustração anteior. [ { "Nome": "grupoA", "Valor": 20, "Operador": null, "Descricao": null, "ValorFormatado": null }, { "Nome": "grupoB", "Valor": 30, "Operador": null, "Descricao": null, "ValorFormatado": null }, { "Nome": "grupoC", "Valor": 50, "Operador": null, "Descricao": null, "ValorFormatado": null }, { "Nome": "FILTROSWHERE", "Valor": " AND P.DATAEMISSAO BETWEEN '01/01/2023' AND '30/06/2023'", "Operador": null, "Descricao": null, "ValorFormatado": null } ]
Para atender os demais relatórios, deve-se pegar os parâmetros dos mesmos, obtido nos passos anteriores, e montar o array de parâmetros conforme a necessidade. [ { "Nome": "Adicionar o nome do parâmetro aqui", "Valor": Adicionar o valor do parâmetro aqui, "Operador": null, "Descricao": null, "ValorFormatado": null }, Caso o relatório necessite de mais parâmetros, replicar o objeto anterior aqui, fazendo a substituição dos valores.]
Observação
A extração do mesmo relatório só é permitida em intervalos de 10 minutos, caso contrário, será exibida a mensagem: "Erro 429 - Too Many Requests".
Microsoft Excel
Atenção
- Dependendo da versão do Excel, as opções podem estar disponibilizadas em outro menu.
- Pode ocorrer a necessidade de efetuar a instalação do Microsoft Power Query.
Para efetuar a extração dos dados para o Excel, deve-se utilizar a mesma URL de extração previamente identificada, assim como o token de acesso que foi obtido anteriormente.
Acessar conteúdo da Web
Caso o Excel exibir a janela de "Acessar conteúdo da Web", basta selecionar a opção de "Anônimo" e depois conectar.
Após adicionada a consulta e acessado o editor do Power Query, encontra-se uma única coluna em que, cada linha corresponde a um registro (record). Ao realizar um duplo clique em qualquer linha, apenas os dados desse registro específico são exibidos.
A próxima etapa consiste em converter esses dados em uma tabela, para tal, deve-se acessar a opção "Transformar" na barra de ferramentas e selecionar a opção "Para a Tabela".
Nessa opção ainda exibe a listagem parecida com a anterior, entretanto, no cabeçalho da coluna tem-se uma opção para expandir e exibir em forma de tabela, basta clicar no ícone 
, permitindo desmarcar caso o usuário desejar não exibir alguma coluna especifica.
Convertendo para tabela
Caso o Excel solicite para definir um delimitador e como tratar as colunas extras, deve-se informar a opção "Nenhum" no delimitador e "Mostrar como erros" as colunas extras.
Após realizada a operação anterior, basta clicar em "Fechar e Carregar" no menu principal, com isso os dados serão abertos na planilha do Excel.
Limitações
A extração se limita a uma quantidade de 100.000 registros.
Consultas customizadas
Caso o sistema não disponha de um relatório que atenda plenamente as necessidades, basta entrar em contato com o suporte Useall para informar a demanda específica. A equipe de suporte estará pronta para analisar a solicitação e encaminhá-la de forma ágil e eficiente à equipe de desenvolvimento.