Uso da API - Guia para Integradores¶

Este guia explica como usar a API do ecosif-compliance.

Autenticação¶

Todos os endpoints protegidos requerem JWT no header:

Authorization: Bearer <seu-token-jwt>

Veja Autenticação para obter um token.

Documentação interativa¶

Swagger UI: http://localhost:8021/docs/
OpenAPI 3 JSON: http://localhost:8021/v3/api-docs
OpenAPI 3 YAML: http://localhost:8021/v3/api-docs.yaml
Export estático: openapi.yaml

Endpoints disponíveis¶

Regras¶

GET /api/compliance/rule/list — listar regras
POST /api/compliance/rule/add — criar regra
POST /api/compliance/rule/update — atualizar regra

Validação¶

POST /api/compliance/run — executar conformidade
POST /api/compliance/test — testar script DSL sem persistir

Consultas¶

GET /api/compliance/cluetype/list
GET /api/compliance/businesssystem/list
GET /api/compliance/document/list
GET /api/compliance/company/list e /company/list/{name}
GET /api/compliance/branch/list e /branch/list/{company_id}

Processos¶

GET /api/compliance/process/result/list/
GET /api/compliance/process/result/list/{since}
GET /api/compliance/process/result/list/{since}/{companyid}
GET /api/compliance/process/result/get/{processid}

Lista completa: lista de endpoints.

Formato de requisições¶

POST de regras, run e test usam:

Content-Type: application/x-www-form-urlencoded

/api/compliance/run também aceita JSON com os mesmos campos.

Formato de respostas¶

Sucesso (200 OK)¶

JSON específico do recurso. Exemplo de listagem de regras:

[
  {
    "id": 1,
    "name": "Validação de Saldo",
    "description": "Valida saldo de contas",
    "clue_type": { "id": 1, "name": "Alerta" }
  }
]

Erro (400/401/403/500)¶

{
  "response-code": 1,
  "response-message": "Mensagem de erro descritiva",
  "message-mode": "ALERT"
}

Códigos de Status HTTP¶

Código	Significado
200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
500	Internal Server Error
503	Service Unavailable (health)