Exemplos de Request/Response - ecosif-compliance

Este documento contém exemplos práticos de requisições e respostas para os principais endpoints.

Obtenha $TOKEN no ecosif-auth (POST /api/auth/signin) — veja Autenticação.

Listar regras

Request

curl -X GET http://localhost:8021/api/compliance/rule/list \
  -H "Authorization: Bearer $TOKEN"

Response (200 OK)

[
  {
    "id": 1,
    "name": "Validação de Saldo",
    "description": "Valida saldo de contas",
    "clue_type": { "id": 1, "name": "Alerta" },
    "business_system": { "id": 1, "name": "COSIF" },
    "documents": [{ "id": 10, "code": "4010", "name": "Balancete" }],
    "base_begin": "2025-01",
    "base_end": "2025-12",
    "validity_begin": "2025-01-01",
    "validity_end": "",
    "script": "RETORNA \"OK\"",
    "standard": false
  }
]

---

Executar validação

Request

curl -X POST http://localhost:8021/api/compliance/run \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "companyid=1&branchid=1&refmonth=2025-11"

Response (200 OK)

Corpo JSON com os processos executados para o recorte informado (empresa/filial + mês).

---

Testar script DSL

Request

curl -X POST http://localhost:8021/api/compliance/test \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode 'script=RETORNA "OK"' \
  -d "refmonth=2025-11"

Response (200 OK)

Resultado da avaliação do script sem gravar processo.

---

Listar processos

Request

curl -X GET "http://localhost:8021/api/compliance/process/result/list/2025-01-01/1" \
  -H "Authorization: Bearer $TOKEN"

Response (200 OK)

[
  {
    "processid": 123,
    "document": "4010",
    "branchid": 1,
    "datetime": "2025-11-10 14:32:01",
    "refdate": "2025-11"
  }
]

---

Detalhe de processo

Request

curl -X GET http://localhost:8021/api/compliance/process/result/get/123 \
  -H "Authorization: Bearer $TOKEN"

Response (200 OK)

{
  "document": "4010",
  "branch": "0001",
  "datetime": "2025-11-10 14:32:01",
  "refdate": "2025-11",
  "results": [
    {
      "rulename": "Validação de Saldo",
      "ruledescription": "Valida saldo de contas",
      "response": {
        "result": "OK",
        "message": "OK"
      }
    }
  ]
}

---

Token ausente ou inválido

Response (401 Unauthorized)

{
  "response-code": 2,
  "response-message": "Invalid Token",
  "message-mode": "ALERT"
}