Referência API PCH-SIG

A API PCH-SIG é uma API REST que permite interagir com todas as funcionalidades do sistema.

URL Base

https://sig.ucp-pch.org/api

Autenticação

A API utiliza JSON Web Tokens (JWT) para autenticação.

Obter um Token

curl -X POST https://sig.ucp-pch.org/api/login \
  -H "Content-Type: application/json" \
  -d '{"email": "user@example.com", "password": "password"}'

Resposta:

{
  "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...",
  "refresh_token": "abc123...",
  "user": {
    "id": 1,
    "email": "user@example.com",
    "roles": ["ROLE_USER", "ROLE_ADMIN"]
  }
}

Utilizar o Token

Inclua o token no cabeçalho Authorization:

curl https://sig.ucp-pch.org/api/menages \
  -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9..."

---

Códigos HTTP

Código	Descrição
200	Sucesso
201	Recurso criado
204	Sucesso sem conteúdo (DELETE)
400	Pedido inválido
401	Não autenticado
403	Acesso negado
404	Recurso não encontrado
422	Erro de validação
500	Erro do servidor

---

Paginação

As coleções são paginadas por defeito (30 elementos por página).

Parâmetros

Parâmetro	Descrição	Exemplo
page	Número da página	?page=2
itemsPerPage	Elementos por página	?itemsPerPage=50

---

Endpoints Principais

Autenticação

Método	Endpoint	Descrição
POST	/api/login	Iniciar sessão
POST	/api/token/refresh	Atualizar token
POST	/api/logout	Terminar sessão

Agregados Familiares

Método	Endpoint	Descrição
GET	/api/menages	Lista de agregados
GET	/api/menages/\{id\}	Detalhe de um agregado
POST	/api/menages	Criar um agregado
PUT	/api/menages/\{id\}	Modificar um agregado
DELETE	/api/menages/\{id\}	Eliminar um agregado

Beneficiários

Método	Endpoint	Descrição
GET	/api/beneficiaires	Lista de beneficiários
GET	/api/beneficiaires/\{id\}	Detalhe de um beneficiário

Ciclos de Pagamento

Método	Endpoint	Descrição
GET	/api/cycles	Lista de ciclos
POST	/api/cycles	Criar um ciclo
POST	/api/cycles/\{id\}/generate	Gerar os pagamentos
POST	/api/cycles/\{id\}/validate	Validar o ciclo