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://api.evidencia.acertpix.com.br/api/analise/123/executar'

Status Code 200

Execução iniciada com sucesso.

Parâmetro	Descrição	Tipo	Exemplos
message	Mensagem de confirmação	String	"Análise iniciada com sucesso"
analise_id	ID da análise em execução	Integer	123
status	Novo status da análise	String	"EmAnalise"
estimativa_minutos	Tempo estimado de conclusão (opcional)	Integer	5

Exemplo

{
  "message": "Análise iniciada com sucesso",
  "analise_id": 123,
  "status": "EmAnalise",
  "estimativa_minutos": 5
}

Status Code 400

Erro de validação - requisitos não atendidos.

Parâmetro	Descrição	Tipo	Exemplos
status	Status da requisição	Integer	1
messages	Lista de mensagens de erro	Array[String]	["Nenhum arquivo anexado à análise"]

Exemplos de Erros Comuns

Sem arquivos anexados:

{
  "status": 1,
  "messages": [
    "Não é possível executar análise sem arquivos anexados"
  ]
}

Arquivos não processados:

{
  "status": 1,
  "messages": [
    "Aguarde o processamento dos arquivos antes de executar a análise"
  ]
}

Análise já executada:

{
  "status": 1,
  "messages": [
    "Esta análise já foi executada. Crie uma nova análise para reprocessar."
  ]
}

Status Code 401

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

Parâmetro	Descrição	Tipo	Exemplos
status	Status da requisição	Integer	1
messages	Lista de mensagens de erro	Array[String]	["Token de autenticação inválido"]

Exemplo

{
  "status": 1,
  "messages": [
    "Token de autenticação inválido ou expirado"
  ]
}

Status Code 403

Acesso negado - a análise pertence a outra empresa.

Parâmetro	Descrição	Tipo	Exemplos
status	Status da requisição	Integer	1
messages	Lista de mensagens de erro	Array[String]	["Acesso negado"]

Exemplo

{
  "status": 1,
  "messages": [
    "Você não tem permissão para executar esta análise"
  ]
}

Status Code 404

Análise não encontrada.

Parâmetro	Descrição	Tipo	Exemplos
status	Status da requisição	Integer	1
messages	Lista de mensagens de erro	Array[String]	["Análise não encontrada"]

Exemplo

{
  "status": 1,
  "messages": [
    "Análise com ID 123 não encontrada"
  ]
}

Status Code 500

Erro interno do servidor.

Parâmetro	Descrição	Tipo	Exemplos
status	Status da requisição	Integer	1
messages	Lista de mensagens de erro	Array[String]	["Erro ao executar análise"]

Exemplo

{
  "status": 1,
  "messages": [
    "Erro interno ao processar a requisição"
  ]
}