Pular para o conteúdo principal

Visão Geral da API

O Clio SIGAD expõe uma API REST para integração com outros sistemas.

Base URL

https://srv1.arboreolab.com.br/api

Autenticação

Todas as requisições requerem autenticação via token JWT.

Obtendo um Token

POST /api/auth/login
Content-Type: application/json

{
"email": "usuario@exemplo.com",
"password": "sua_senha"
}

Resposta:

{
"success": true,
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"user": {
"id": 1,
"email": "usuario@exemplo.com",
"role": "admin"
}
}

Usando o Token

Inclua o token no header Authorization:

GET /api/documentos
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...

Endpoints Principais

Documentos

MétodoEndpointDescrição
GET/api/documentosListar documentos
GET/api/documentos/:idObter documento
POST/api/documentosCriar documento
PUT/api/documentos/:idAtualizar documento
DELETE/api/documentos/:idRemover documento

Busca

MétodoEndpointDescrição
POST/api/busca/simplesBusca por palavras-chave
POST/api/fregerag/searchBusca semântica RAG

OCR

MétodoEndpointDescrição
GET/api/gerenciador-dados/ocrListar OCRs
POST/api/ocr/processarIniciar processamento

Paginação

Endpoints de listagem suportam paginação:

GET /api/documentos?page=1&limit=50

Resposta:

{
"success": true,
"data": [...],
"pagination": {
"page": 1,
"limit": 50,
"total": 20543,
"pages": 411
}
}

Códigos de Status

CódigoDescrição
200Sucesso
201Criado com sucesso
400Requisição inválida
401Não autenticado
403Sem permissão
404Não encontrado
500Erro interno