Objetivo #
Este documento demonstra o fluxo de download de arquivos através da API.
Autenticação #
Solicite uma autorização de acesso Basic Auth ao administrador da API. Todas as rotas necessitam de autenticação.
A API é conectada via arquivo .env de configuração ao Serviço MsManager com o uso de JWT Token.
Rotas Construídas #
URL de Produção (PRD): https://api-download-prod.businessintegrator.com.br
URL de Produção (QAS): https://api-download-qas.businessintegrator.com.br
Listar Arquivos #
Essa rota permite listar os arquivos pendentes para download.
Método: GET
Endpoint: {{URL_API}}/listar-arquivos?chave_metod={{CHAVE-METOD}}&chave_hardware={{CHAVE-HARDWARE}}
Notas:
• Solicite a chave de método e a chave de hardware ao administrador da API.
Exemplo de Resposta (quando existem arquivos pendentes):
Mostrar Conteúdo dos Arquivos #
Essa rota permite acessar o conteúdo dos arquivos disponíveis para download. O formato padrão de retorno é base64.
Método: POST
Endpoint: {{URL_API}}/mostrar-conteudo/:id_arquivo?chave_hardware={{CHAVE-HARDWARE}}
Exemplo de Resposta (arquivo ainda não visualizado):
Exemplo de Resposta (arquivo já visualizado):
Receber Conteúdo em Formato JSON
Para integrações que suportam JSON, utilize os seguintes parâmetros:
Método: POST
Endpoint: {{URL_API}}/mostrar-conteudo/:id_arquivo/:retornar_conteudo/?chave_hardware={{CHAVE-HARDWARE}}
Parâmetros:
• ‘id_arquivo‘: ID do arquivo.
•’retornar_conteudo‘: ‘S’ para retornar o conteúdo em JSON.
Exemplo de Resposta JSON:
Declarar Baixa #
Essa rota permite declarar a baixa de um arquivo, marcando-o como concluído.
Método: GET
Endpoint: {{URL_API}}/declarar-baixa?chave_hardware={{CHAVE}}&id_arquivo={{ID}}
Exemplo de Resposta (arquivo não declarado previamente):
Exemplo de Resposta (arquivo já declarado):
Caso tenha dúvidas ou precise de suporte adicional, entre em contato com o administrador da API.