Pular para o conteúdo principal

Upload de Arquivos

POST [Url Ambiente]/api/Analise/{id}/upload

Esse endpoint é utilizado para enviar (upload) um documento que será anexado a uma análise. Cada requisição aceita apenas um arquivo por vez.

IdentificadorValor
Content-typemultipart/form-data
Acceptapplication/json
AuthorizationBearer [Valor do token retornado na Autenticação]

Parâmetros de URL

ParâmetroDescriçãoTipoExemplosObrigatório
idIdentificador único da análiseInteger123Sim

Form Data

ParâmetroDescriçãoTipoObrigatório
arquivoArquivo a ser enviado (máx. 512 MB)FileSim
tipoDocumentoTipo/categoria do documentoStringNão
descricaoDescrição do documentoStringNão

Exemplo CURL

curl -X POST \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6...' \
--form 'arquivo=@/path/to/contrato.pdf' \
--form 'tipoDocumento=Contrato' \
--form 'descricao=Contrato de prestação de serviços' \
'https://evidenciaapi.acertpix.com.br/api/Analise/123/upload'

Status Code 200

Upload realizado com sucesso.

ParâmetroDescriçãoTipoExemplos
idIdentificador do arquivoInteger456
nomeNome do arquivo processadoString"contrato_20250120101000.pdf"
tipoContent-Type do arquivoString"application/pdf"
tamanhoTamanho em bytesInteger2048576
statusStatus de processamentoString"Recebido"
tipoDocumentoTipo do documento (se informado)String"Contrato"
descricaoDescrição do documento (se informada)String"Contrato de prestação de serviços"

Exemplo

{
"id": 456,
"nome": "contrato_20250120101000.pdf",
"tipo": "application/pdf",
"tamanho": 2048576,
"status": "Recebido",
"tipoDocumento": "Contrato",
"descricao": "Contrato de prestação de serviços"
}

Exemplo sem campos opcionais

{
"id": 457,
"nome": "anexo_20250120101030.jpg",
"tipo": "image/jpeg",
"tamanho": 1024000,
"status": "Recebido",
"tipoDocumento": null,
"descricao": null
}

Status Code 400

Erro de validação no arquivo enviado.

ParâmetroDescriçãoTipoExemplos
errorCódigo do erroString"no_file"
errorDescriptionDescrição do erroString"Nenhum arquivo foi enviado"

Exemplos de Erros Comuns

Nenhum arquivo enviado:

{
"error": "no_file",
"errorDescription": "Nenhum arquivo foi enviado"
}

Arquivo muito grande:

{
"error": "file_too_large",
"errorDescription": "O arquivo excede o tamanho máximo permitido de 512MB"
}

Status Code 401

Requisição não autenticada ou token inválido/expirado.

ParâmetroDescriçãoTipoExemplos
errorCódigo do erroString"unauthorized"
errorDescriptionDescrição do erroString"Token inválido ou empresa não identificada"

Exemplo

{
"error": "unauthorized",
"errorDescription": "Token inválido ou empresa não identificada"
}

Status Code 404

Análise não encontrada.

ParâmetroDescriçãoTipoExemplos
errorCódigo do erroString"not_found"
errorDescriptionDescrição do erroString"Análise não encontrada"

Exemplo

{
"error": "not_found",
"errorDescription": "Análise não encontrada"
}

Status Code 500

Erro interno do servidor.

ParâmetroDescriçãoTipoExemplos
errorCódigo do erroString"server_error"
errorDescriptionDescrição do erroString"Erro interno ao processar upload"

Exemplo

{
"error": "server_error",
"errorDescription": "Erro interno ao processar upload"
}

Observações

  • A API aceita apenas um arquivo por requisição. Para enviar múltiplos arquivos, faça múltiplas requisições
  • O tamanho máximo por arquivo é de 512 MB
  • Os campos tipoDocumento e descricao são opcionais e servem para organizar e identificar os documentos
  • O nome do arquivo será processado automaticamente com timestamp para evitar conflitos
  • O arquivo ficará com status "Recebido" até ser processado

Próximos Passos

Após fazer upload dos arquivos:

  1. Executar Análise - Inicie o processamento dos documentos
  2. Consultar Análise por ID - Verifique o status e resultados
  3. Consultar Análise por Chave - Busque usando a chave única