Inclusão de arquivos na estrutura

Este endpoint é responsável por recuperar arquivos vinculados a uma entidade em nossa estrutura, ele retornará o arquivo no formato Base64.

Método: POST

URI do Endpoint: https://integration-marketplace.orbia.nom.co/orbia-marketplace-hub/v1/file

Requisição e Tipos de Dados

Tipo de Conteúdo da Requisição: application/json

Corpo da Requisição:

Para recuperar os dados do pedido, devemos informar o id do pedido.

• fileBase64(string, obrigatória, query): Base64 completo do arquivo que irá subir em nossa estrutura.

• fileName(int, obrigatória, query): Identificador da entidade relacionada ao arquivo.

Tipos de arquivos suportados:

• Imagens

image/jpeg,

image/png,

• Documentos

application/pdf

Exemplo de Requisição:

{
  "fileBase64": "string",
  "fileName": "string"
}

Possíveis Respostas

Códigos de Resposta e seus significados:

Status Code	Descrição
200	Sucesso.
400	Bad Request: Erro de validação ou processamento da requisição.
401	Unauthorized: Autenticação necessária e não fornecida.
403	Forbidden: A requisição foi autenticada, mas o usuário não tem permissões para a ação.
502	BadGateway: indica que ele, enquanto atuando como um servidor intermediário, recebeu uma resposta inválida do servidor para o qual a requisição foi encaminhada.

Exemplos de Respostas:

Importância do Hash de Arquivo

É fundamental armazenar o hash de arquivo, que é um GUID único, pois ele será utilizado nos endpoints que solicitam arquivos, como o de remessa. Esse hash faz referência ao arquivo em uma estrutura temporária, portanto, é crucial utilizá-lo em um prazo razoável.

Note que o hash não deve ser armazenado por um período prolongado, pois sua finalidade é fornecer acesso temporário ao arquivo. Além disso, é essencial garantir que o hash seja utilizado corretamente nos endpoints que o solicitam, para evitar erros e garantir a integridade dos dados.

• Sucesso (200):

{
  "hashFile": "string"
}

• Erro (400):

{
  "statusCode": 400,
  "message": "Erro de validação.",
  "errors": {
    "additionalProp1": ["Erro específico 1"],
    "additionalProp2": ["Erro específico 2"],
    "additionalProp3": ["Erro específico 3"]
  }
}

Cómo Testar o Endpoint

Para testar este endpoint, você pode usar ferramentas como Postman ou cURL. Siga as instruções abaixo:

1. Abra o Postman.

2. Selecione o método POST e insira a URL do endpoint.

3. No corpo da requisição, insira o JSON do exemplo fornecido.

4. Envie a requisição e observe a resposta.

Importante

Para um teste bem-sucedido, certifique-se de que você tem as credenciais corretas (se necessário) e que o corpo da requisição está corretamente formatado conforme o exemplo.

Este documento serve como um guia básico para entender e testar o endpoint específico. Ajuste as seções conforme necessário para se adequar ao seu ambiente de negócios e práticas de desenvolvimento.