Vale a pena relembrar
Diagnóstico
API de upload
Por Carlos Cornejo
A ferramenta Diagnóstico tem como principal objetivo realizar validações de documentos fiscais e retornar um resultado em JSON, com os comparativos dos dados informados no arquivo e os dados da Systax.
Nesse fluxo existem 3 API’s que são responsáveis pelo recebimento, processamento e devolução do arquivo. São elas: API de Upload, API de Listagem e API de Resultado.
Nessa matéria vamos ver a API de Upload. A primeira que deve ser utilizada, conforme fluxo acima.
Ela é responsável pela importação dos arquivos que serão analisados, dentro da ferramenta.
Autenticação
Para o funcionamento da API é necessário gerar um token e realizar a autenticação, assim como é padrão em nossas outras API’s.
URL: https://app.systax.com.br/auth/access-token
Método: GET
Exemplo:
Com o token gerado, basta utilizá-lo na API de Upload.
|
Informar o ID cliente da empresa |
Acesso:
URL: https://api-gateway.systax.com.br/parceiros/api/diagnostico/upload?id_empresa=_______________
Método: POST
Abaixo um exemplo de chamada para o envio dos arquivos:
Exemplo de retorno:
{
"sucesso": true,
"mensagem": null,
"dados": {
"nome_arquivo": "6b03f72e-66cf-4931-a66f-8f61dd64391e.zip",
"status": "Finalizado",
"mensagem_erro": null,
"config_blob": " empresateste "
}
}
Importante: O nome do arquivo será utilizado como referência para verificar o retorno da consulta na API de Listagem.
Padrão de arquivos
A API de Diagnóstico trabalha com um padrão específico para os arquivos, que deve ser respeitado para que o funcionamento ocorra como esperado e o retorno seja satisfatório.
No padrão em questão a pasta com os arquivos deve estar zipada e dentro dela deve ter uma subpasta com o nome NFE ou NFSE, dependendo do tipo da nota. Dentro da subpasta estarão os arquivos para o Upload.
Segue exemplo:
Pasta zipada
Subpasta
Arquivos para Upload
Seguindo esse padrão, basta inserir o arquivo, conforme print de exemplo da chamada e rodar a API.
Conclusão: A API de Upload inicia o processo da nossa ferramenta de Diagnóstico, que será responsável pelas validações fiscais e é de extrema importância que os parâmetros estejam corretos, para que o processamento aconteça da forma esperada.