Processo de Exportação¶

Conhecer o Processo¶

O que é?¶

Documentação do processo de exportação via API.

Roteiro de Implantação¶

Cadastro do SQL

Para utilizar o processo de exportação por API, é necessário cadastrar o SQL desejado no Cadastro de Processos de Exportação (FINT0202) com o método API selecionado, conforme o exemplo abaixo:

Observação

O cadastro inicia com o indicador Ativo desmarcado. Para ativar, é necessário clicar em “Validar SQL” após o cadastro.

Para outros detalhes, consulte o Help do FINT0202.

Autenticação

Para consumir a API é necessário informar um Token de acesso, é possível criá-lo pelo Cadastro de Tokens de Acesso (FUTL0243). Nessa tela, ao clicar em Gerar Token, a tela abaixo é exibida:

É necessário informar o Nome, Descrição e Empresa do Token.

Consumo da API

Vamos utilizar o Postman para demonstrar o consumo da API nos métodos GET e POST.

Observação

O parâmetro Take (que define o número de registros que serão retornados) por padrão recebe o valor 100 quando não informado. Por questões de performance este parâmetro possui um limite de valor 1000, ou seja, quando informado um valor maior que 1000 a API não buscará o valor informado, mas sim o limite de 1000 registros. Se necessário buscar registros além do limite de 1000, deve-se fazer uma combinação com os parâmetros Skip e Take para gerenciar a paginação da pesquisa.

Método GET

Método: GET

URL: <IP-SERVIDOR>/FoccoIntegrador/api/v1/Exportacao/MNEMONICO_PROCESSO (exibida no FINT0202)?Chave=6303058072&Skip=0&Take=20

Autenticação: Bearer Token (informe o Token gerado na etapa anterior)

Params: Abaixo segue um exemplo de parâmetros utilizados, devem ser informados na própria URL.

"Chave": "6303058072", // Chave do FoccoIntegrador (FINT0200)

"Skip": 0, // Quantidade de registros para pular (paginação)

"Take": 20 // Quantidade de registros para coletar

Exemplo utilizando o Postman:

Também é possível filtrar e ordenar os resultados informando os parâmetros na URL da requisição.

URL: <IP-SERVIDOR>/FoccoIntegrador/api/v1/Exportacao/MNEMONICO_PROCESSO?Chave=6303058072&Skip=0&Take=20&empr_id=10&orderDesc=empr_id&orderAsc=num_pedido,aliq_ipi

Exemplo utilizando o Postman:

Filtros de busca

Os filtros disponíveis para busca são:

Função	Símbolo	Exemplo de Uso
IGUAL	=	"102030" ou "=102030"
DIFERENTE	!=	!=102030
MAIOR	>	>102030
MAIOR OU IGUAL	>=	>=102030
MENOR	<	<102030
MENOR OU IGUAL	<=	<=102030
IN	&	&102030,405060
NOT IN	!&	!&102030,405060
LIKE	%	"%ELETRO" ou "%ALCAMAR%ELETRO"
NOT LIKE	!%	"!%ELETRO" ou "!%ALCAMAR%ELETRO"

Método POST

Método: POST

URL: <IP-SERVIDOR>/FoccoIntegrador/api/v1/Exportacao/MNEMONICO_PROCESSO (exibida no FINT0202)

Autenticação: Bearer Token (informe o Token gerado na etapa anterior)

Body: Abaixo segue um exemplo de JSON utilizado.

{

"Chave": "6303058072", // Chave do FoccoIntegrador (FINT0200)

"Skip": 0, // Quantidade de registros para pular (paginação)

"Take": 2 // Quantidade de registros para coletar

}

Exemplo utilizando o Postman:

Também é possível filtrar e ordenar os resultados informando os parâmetros no Body da requisição.

{

    "Chave": "6303058072",

    "Skip": 0,

    "Take": 20,

    "Parameters": [ // Filtros (é possível informar mais de um)

        {

            "Column": "empr_id", // Coluna da tabela do banco de dados

            "Value": 10 // Valor

        }

    ],

    "Sorting": [ // Ordenações (é possível informar mais de um)

        {

            "ByColumn": "num_pedido", // Coluna da tabela do banco de dados

            "Sort": "DESC" // Tipo de ordenação: ASC/DESC

        }

    ]

}

Outros filtros são possíveis através de sinais: “<” para menor que, “>” para maior que, “<=” para menor ou igual a, “>=” para maior ou igual a e “!=” para diferente de. Caso a necessidade seja filtrar apenas “igual a”, não é necessário utilizar o sinal “=”, basta informar o valor a ser consultado apenas. Abaixo, exemplo utilizando o Postman:

Filtros Obrigatórios

Caso seja necessário, é possível informar filtros obrigatórios no Cadastro de Processos de Exportação (FINT0202), na aba Parâmetros.

Observação

Lembre de selecionar a opção “Obrigatório”.

A mensagem de erro ao consumir a API é exibida conforme o exemplo abaixo: