API - Gerar Relatório

O serviço de relatórios é um dos recursos oferecidos através das API’s da Suíte Gen.te
Nuvem.

Endpoint: https://prd-api1.lg.com.br/v1/ServicoDeRelatorio

 

Como gerar o relatório? 

Para gerar o relatório por meio do serviço de relatório, siga os passos descritos a seguir:

 

1. Localizar o gerador de relatório.

 

2. Escolher o relatório a ser emitido.

Nessa etapa, deve-se escolher um relatório que contenha diversos valores. Por exemplo, no campo de matrícula, é possível selecionar mais de uma matrícula para um único campo. Por essa razão, deve-se utilizar o endpoint GerarRelatorio, ao invés do GerarRelatorioPorNome.

3. Informar os parâmetros necessários para a emissão do relatório.

4. Pressionar F12 (ou clicar com o botão direito em algum canto da tela e selecionar "Inspecionar") e selecionar a aba Network. Em seguida, clicar no ícone do círculo cortado, destacado na imagem, para limpar todos os dados de rede, facilitando a localização dos arquivos desejados.

 

5. Clicar em "Emitir Relatório" com a tela do "Inspecionar" aberta.

 

6. Esperar pela geração da informação escrita "GereListaRelatorio".

 

7. Em "GereListaRelatorio", localizar o "Payload" e, em seguida, procurar por "dadosRelatorio". Copiar toda a informação dentro de "dadosRelatorio".

 

 

8. Colocar o conteúdo copiado em um formatador de JSON (https://jsonformatter.curiousconcept.com) para facilitar o entendimento das informações.

 

9. Colocar os dados em um editor de texto para facilitar a visualização. Dentro do editor de texto, procurar pelo campo "ListaDeGruposDeParametros" e minimizar todos os grupos.

 

10. Acrescentar um nome na frente de cada grupo para garantir um controle mais fácil dos dados.

 

11. Abrir o SoapUI e selecionar o endpoint GerarRelatorio.

 

12. Para facilitar o consumo da API, copiar todo o envelope XML do SoapUI e colocá-lo em um arquivo de texto.

 

13. Selecionar o campo <!--Optional:--> e substituir por um campo em branco, com a finalidade de diminuir a quantidade de linhas.

 

14. Colar novamente o XML no SoapUI e pressionar ALT + F. Esse comando fará uma indentação, removendo os campos em branco deixados ao retirar as palavras <!--Optional:-->.

 

15. Localizar dentro do XML o campo <v11:GrupoDeParametros>. Abaixo dele, estará o objeto<v11:GrupoDeParametros>

 

16. Selecionar o objeto do GrupoDeParametros inteiro e colá-lo na mesma quantidade de grupos feita no passo 10.

 

 

17. Iniciar o preenchimento do XML com os dados obtidos no formato JSON no passo 8.

 

18. Todo campo no XML tem seu campo respectivo no JSON. Deve-se copiar o conteúdo de cada campo do JSON e colocá-lo no campo correspondente dentro do XML. Não importa se o valor contém #, ,ou *. Caso o valor esteja entre aspas, deve-se copiar apenas o conteúdo dentro das aspas, sem as aspas.

Obs.1: O Grupo 1 no XML é referente ao Grupo 1 no JSON.

Obs.2: Se o campo "MascaraFormatacao" estiver vazio no JSON, no XML, o campo "MascaraFormatacao" poderá ser apagado.

QUALQUER campo VAZIO, NULLO ou sem informação, não será preenchido no XML e será apagado. Ou seja, se  campo ”MascaraFormatacao” estiver vazio no JSON, então no XML, no campo MascaraFormatacao poderá ser apagado

Exemplo de campos que pode sem apagados se não tiverem informação:

"Exemplo" : ""
"Exemplo" : null
"Exemplo": 

Outro preenchimento necessário é o caso de encontrar um valor dentro de chaves como na imagem a baixo:

Nesse caso, será feito da seguinte maneira:

• Copie o valor completo.
  Exemplo:
  "Valor" : "{\"Sql\":\"\",\"Codigo\":0,\"Descricao\":\"\"}"
• Pegaremos apenas os dados dentro das chaves
  {\"Sql\":\"\",\"Codigo\":0,\"Descricao\":\"\"}
  sem a primeira e a ultima aspas duplas
• Por ultimo, removeremos TODAS as \
  {"Sql":"","Codigo":0,"Descricao":""}

 

19. Quando o JSON contiver vários valores dentro de um objeto, como no caso do objeto Opcoes, o objeto filho deve ser repetido. Ele estará evidenciado por um comentário de <!--Zero or more repetitions-->. Se houver 3 objetos no JSON, o objeto ValorParametro no XML será repetido 3 vezes.

Obs: Há 3 objetos no JSON, logo o objeto ValorParametro no XML foi repetido 3 vezes.

Se o JSON contiver informações a menos, resultando em campos em branco no XML, esses campos devem ser apagados, deixando apenas os valores.

 

20. Após o preenchimento correto de todos os grupos (por exemplo, 10 grupos), deve-se executar o endpoint.

Execute o endpoint:

O código gerado no retorno da API deve ser copiado.

 

21. Agora, será necessário trocar de endpoint, indo para o endpoint ConsultarTarefa. Dentro desse endpoint, deve-se colar o ID da tarefa obtido no retorno da API GerarRelatorio no passo 20.

Obs: Os possíveis status de processamento para a tarefa são:
3550 - Erro na execução da tarefa
3551 - Concluída
3552 - Em execução
3568 - Aguardando execução
3465 - Cancelada
3569 - Aguardando cancelamento
14296 - Não respondendo
36996 - Em processo de cancelamento
39470 - Concluída com inconsistências

 

22. Se for utilizado o SoapUI para gerar o link, o link gerado deve ser copiado, colocado em um editor de texto e todos os & devem ser substituídos por &.

 

23.  Colocar o link gerado na URL. Isso realizará o download direto do arquivo.

Obs: O link expira 10 minutos após sua geração. Caso expire, basta gerar um novo link utilizando o passo 21. Não será necessário gerar o relatório novamente, apenas gerar um novo link.
Obs: Se houver modificação nos dados do relatório, será necessário gerar novamente desde o passo 1.

 

24. O relatório será gerado.