Executar Análise

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

Esse endpoint é utilizado para iniciar o processamento e análise dos documentos previamente anexados a uma análise. A execução é assíncrona e você pode acompanhar o progresso consultando o status.

Header

Identificador	Valor
Content-type	application/json
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

Body

Este endpoint não requer corpo na requisição.

Exemplo CURL

curl -X POST \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6...' \
  'https://evidenciaapi.acertpix.com.br/api/Analise/123/executar'

Status Code 202

Execução iniciada com sucesso (Accepted - processamento assíncrono).

Parâmetro	Descrição	Tipo	Exemplos
analiseId	ID da análise em execução	Integer	123
status	Novo status da análise	String	"EmAnalise"
mensagem	Mensagem de confirmação	String	"Análise enfileirada para processamento. Consulte o status usando GET /api/Analise/{id}"

Exemplo

{
  "analiseId": 123,
  "status": "EmAnalise",
  "mensagem": "Análise enfileirada para processamento. Consulte o status usando GET /api/Analise/{id}"
}

Status Code 400

Erro de validação - análise sem arquivos.

Parâmetro	Descrição	Tipo	Exemplos
error	Código do erro	String	"no_files"
errorDescription	Descrição do erro	String	"A análise não possui arquivos. Envie arquivos antes de executar."

Exemplo

{
  "error": "no_files",
  "errorDescription": "A análise não possui arquivos. Envie arquivos antes de executar."
}

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 executar análise"

Exemplo

{
  "error": "server_error",
  "errorDescription": "Erro interno ao executar análise"
}

Observações

• A execução da análise é assíncrona. O endpoint retorna imediatamente com status 202 Accepted
• A análise precisa ter pelo menos um arquivo anexado para poder ser executada
• Após a execução, a análise ficará com status "EmAnalise" durante o processamento
• Use os endpoints de consulta (por ID ou por chave) para acompanhar o progresso

Próximos Passos

Após executar a análise:

1. Consultar Análise por ID - Acompanhe o status e obtenha os resultados
2. Consultar Análise por Chave - Busque usando a chave única