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étodo | Endpoint | Descrição |
|---|---|---|
GET | /api/documentos | Listar documentos |
GET | /api/documentos/:id | Obter documento |
POST | /api/documentos | Criar documento |
PUT | /api/documentos/:id | Atualizar documento |
DELETE | /api/documentos/:id | Remover documento |
Busca
| Método | Endpoint | Descrição |
|---|---|---|
POST | /api/busca/simples | Busca por palavras-chave |
POST | /api/fregerag/search | Busca semântica RAG |
OCR
| Método | Endpoint | Descrição |
|---|---|---|
GET | /api/gerenciador-dados/ocr | Listar OCRs |
POST | /api/ocr/processar | Iniciar 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ódigo | Descrição |
|---|---|
200 | Sucesso |
201 | Criado com sucesso |
400 | Requisição inválida |
401 | Não autenticado |
403 | Sem permissão |
404 | Não encontrado |
500 | Erro interno |