Última modificação em: 10/10/2022

Integração Exportar

POST - /Integracao/Exportar

Permite exportar os dados dos cadastros do sistema.

Parâmetros

Parâmetro

Obrigatório

Tipo do Parâmetro

Descrição

Valores Válidos

tokenapi

Não

Texto

Token de validação do acesso. Se a base de dados possuir um token cadastrado passa a ser obrigatório informar o mesmo

 

Body

Informar no body um JSON contendo o leiaute ou o datamodule que serão exportados.

Existem duas formas de fazer a exportação, uma com um leiaute repassado pelo usuário e uma com apenas um datamodule informado.

Na primeira, informa-se apenas um datamodule que deve ser exportado. Neste formato, os campos serão os campos padrão do datamodule. Pode-se informar um filtro para aplicar aos dados antes de importar.

Ex:

{

  "datamodule":"TnGemDMAgencia", "filtro":"CODIGOBANCO=1"

}

Na segunda, informa-se os leiautes a serem utilizados para a exportação dos dados. Este segue o mesmo padrão dos leiautes fixo/variável de tributário, podendo ser informado no formato Base64 ou JSON.

Exemplo Base 64:

{

  "leiautes":[{"nome":"idioma.nli", "arquivo":"b2JqZWN0IFRuSXRlbUltcG9ydGFjYW8KICBEZWxpbWl0YWRvciA 9ICMwCiAgRE1DbGFzc05hbWUgPSAnVG5DdGJE..."}, ...],

"filtro":""

}

Exemplo JSON:

{

  "leiautes":[{"nome":"idioma.nli", "arquivo":""object TnItemImportacao\r\n  Delimitador = #0\r\n

 DMClassName = 'TnCtbDMLctoCtb'\r\n..."}, ...], "filtro":"",

}

Respostas

Resposta Conteúdo
200 Irá retornar o conteúdo do arquivo gerado na exportação, varia de acordo com os leiautes informados.
401

Acontece quando a base possui um token de validação que não foi repassado através do parâmetro "tokenapi" ou está incorreto. Ex:

{

"errorCode": 401,

"errorText": "Acesso negado, verifique o to ken informado."

}

 

CCQ Blog
© Questor Sistemas 2025