Documentação do Microserviço de Upload Múltiplos Arquivos

Descrição #

Este microserviço foi desenvolvido para receber e fazer o upload de arquivos de diferentes formatos no Business Integrator. A API suporta arquivos convertidos em Base64, garantindo a flexibilidade no envio e armazenamento de diversos tipos de arquivos.

Requisitos #

Para utilizar a API, é necessário:

Autenticação via msman: O processo de autenticação gera um token JWT que deve ser incluído nas requisições subsequentes.

Autenticação #

Antes de acessar a rota de upload, é necessário obter um token de autenticação:

• URL de Autenticação (msman):
• https://msman-prd-oke.businessintegrator.com.br/auth
• O processo de autenticação deve ser feito com as credenciais fornecidas pela equipe, enviando uma requisição ao endpoint acima. Após a autenticação bem-sucedida, o serviço retornará um Bearer Token.

Exemplo de Requisição – Autenticação (Basic Auth) #

Endpoint #

código -> POST https://msman-prd-oke.businessintegrator.com.br/auth

Cabeçalhos #

http códigoAuthorization: Basic {base64(user:password)}
Content-Type: application/json

Corpo da Requisição (JSON) #

O corpo da requisição pode estar vazio, já que as credenciais de autenticação são passadas via Basic Auth no cabeçalho.

json código{}

Exemplo de Requisição HTTP (com Curl) #

bash código:
curl -X POST 'https://msman-prd-oke.businessintegrator.com.br/auth' \
-H 'Authorization: Basic dXNlcm5hbWU6c2VuaGE=' \
-H 'Content-Type: application/json' \
-d '{}'

Exemplo de Retorno de Sucesso #

json 
código{
    "success": true,
    "data": {
        "aplication": "APP_Teste",
        "id": 16,
        "name": "testando",
        "description": "Aplicacao",
        "bearer_token": "fsfdsfsdsfbebfdbddsfbvdsvdsf",
        "token_creation_date": "2024-10-07T16:10:33.000Z",
        "token_expires_date": "2024-10-12 13:10:33",
        "token_legible_expires_date": "13:10:33 GMT-0300 (Brasilia Standard Time)",
        "user_agent": "PostmanRuntime/7.42.0"
    }
}

Explicação dos Campos do Retorno: #

• aplication: Nome da aplicação autenticada.
• id: ID da aplicação.
• name: Nome do usuário ou cliente autenticado.
• description: Descrição da aplicação.
• bearer_token: Token JWT gerado para autenticação nas demais requisições.
• token_creation_date: Data e hora de criação do token.
• token_expires_date: Data e hora de expiração do token.
• token_legible_expires_date: Data legível de expiração com fuso horário GMT-3.
• user_agent: User Agent utilizado na requisição

Endpoint de Upload #

Após obter o token de autenticação, o upload dos arquivos pode ser feito na seguinte rota:

• URL de Upload:
• https://msman-qas-oke.businessintegrator.com.br/BIZ_UPLOAD/upload
• Cabeçalho de Autorização:
• Authorization: Bearer {token}

Métodos Suportados #

A API utiliza o método POST para upload de arquivos. O corpo da requisição deve ser enviado no formato JSON.

Estrutura do Corpo da Requisição #

A estrutura do body da requisição deve seguir o seguinte padrão:

{
    "parameters": {
        "fileName": "teste",
        "fileExtension": "json",
        "fileContent": "ewogICJ0ZXN0ZSI6ICJUZXN0YW5kbyIKfQo="
    }
}

• fileName: Nome do arquivo (sem a extensão).
• fileExtension: Extensão do arquivo (exemplo: json, txt, pdf).
• fileContent: Conteúdo do arquivo convertido para Base64.

Exemplo de Requisição #

POST /BIZ_UPLOAD/upload HTTP/1.1
Host: msman-qas-oke.businessintegrator.com.br
Authorization: Bearer {token}
Content-Type: application/json

{
    "parameters": {
        "fileName": "relatorio",
        "fileExtension": "pdf",
        "fileContent": "JVBERi0xLjcKJcfs..."
    }
}

Exemplo de Retorno de Sucesso #

Se o upload for realizado com sucesso, a resposta será a seguinte:

{
    "success": true,
    "message": "Arquivo relatorio salvo com sucesso na pasta compartilhada!"
}

Observações #

• Certifique-se de que o arquivo seja corretamente convertido para o formato Base64 antes de ser enviado.
• O fileName e o fileExtension devem seguir os padrões aceitos pelo sistema.
• Sempre utilize o Bearer Token gerado na autenticação no cabeçalho das requisições.

Fluxo do Serviço #

1. Autenticação: Consulte o msman com o user e senha fornecidos pela equipe para gerar um token JWT.
2. Envio do Token: Inclua o token no cabeçalho de autorização como Bearer Token.
3. Requisição de Upload: Após a autenticação, utilize o token para enviar arquivos por meio da rota de upload.

---

Caso precise de mais informações ou suporte, entre em contato com a equipe de integração.