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.
Header
| Identificador | Valor |
|---|---|
| Content-type | multipart/form-data |
| Accept | application/json |
| Authorization | Bearer [Valor do token retornado na Autenticação] |
Parâmetros de URL
| Parâmetro | Descrição | Tipo | Exemplos | Obrigatório |
|---|---|---|---|---|
| id | Identificador único da análise | Integer | 123 | Sim |
Form Data
| Parâmetro | Descrição | Tipo | Obrigatório |
|---|---|---|---|
| arquivo | Arquivo a ser enviado (máx. 512 MB) | File | Sim |
| tipoDocumento | Tipo/categoria do documento | String | Não |
| descricao | Descrição do documento | String | Nã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âmetro | Descrição | Tipo | Exemplos |
|---|---|---|---|
| id | Identificador do arquivo | Integer | 456 |
| nome | Nome do arquivo processado | String | "contrato_20250120101000.pdf" |
| tipo | Content-Type do arquivo | String | "application/pdf" |
| tamanho | Tamanho em bytes | Integer | 2048576 |
| status | Status de processamento | String | "Recebido" |
| tipoDocumento | Tipo do documento (se informado) | String | "Contrato" |
| descricao | Descriçã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âmetro | Descrição | Tipo | Exemplos |
|---|---|---|---|
| error | Código do erro | String | "no_file" |
| errorDescription | Descrição do erro | String | "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âmetro | Descrição | Tipo | Exemplos |
|---|---|---|---|
| error | Código do erro | String | "unauthorized" |
| errorDescription | Descrição do erro | String | "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âmetro | Descrição | Tipo | Exemplos |
|---|---|---|---|
| error | Código do erro | String | "not_found" |
| errorDescription | Descrição do erro | String | "Análise não encontrada" |
Exemplo
{
"error": "not_found",
"errorDescription": "Análise não encontrada"
}
Status Code 500
Erro interno do servidor.
| Parâmetro | Descrição | Tipo | Exemplos |
|---|---|---|---|
| error | Código do erro | String | "server_error" |
| errorDescription | Descrição do erro | String | "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
tipoDocumentoedescricaosã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:
- Executar Análise - Inicie o processamento dos documentos
- Consultar Análise por ID - Verifique o status e resultados
- Consultar Análise por Chave - Busque usando a chave única