API REST v1

API Reference

Integre o MaximusPI com os seus sistemas através da nossa API REST completa e bem documentada.

v1.0
Versão Actual
REST
Arquitectura
JSON
Formato
Bearer
Autenticação

Autenticação

A API utiliza tokens Bearer para autenticação. Inclua o token em todas as requisições.

  1. 1 Aceda às Configurações → API no seu painel
  2. 2 Gere um novo token de API
  3. 3 Inclua o token no header Authorization
Header de Autenticação
Authorization: Bearer YOUR_API_TOKEN

Content-Type: application/json
Accept: application/json

Endpoints

Explore todos os endpoints disponíveis na API

Colaboradores

GET /api/v1/colaboradores Listar todos os colaboradores
Parâmetros Query
Parâmetro Tipo Descrição
page integer Número da página (default: 1)
per_page integer Itens por página (default: 20, max: 100)
departamento_id integer Filtrar por departamento
status string Filtrar por status (ativo, inativo)
Resposta
{
  "success": true,
  "data": [
    {
      "id": 1,
      "nome": "João Silva",
      "email": "joao@empresa.com",
      "departamento": "Tecnologia",
      "cargo": "Desenvolvedor Senior",
      "status": "ativo"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 20,
    "total": 150
  }
}
GET /api/v1/colaboradores/{id} Obter colaborador específico
Resposta
{
  "success": true,
  "data": {
    "id": 1,
    "nome": "João Silva",
    "email": "joao@empresa.com",
    "telefone": "+244 951 001 904",
    "departamento_id": 5,
    "cargo_id": 12,
    "data_admissao": "2023-01-15",
    "status": "ativo"
  }
}
POST /api/v1/colaboradores Criar novo colaborador
Body (JSON)
Campo Tipo Descrição
nomeREQUIRED string Nome completo
emailREQUIRED string Email corporativo
departamento_idREQUIRED integer ID do departamento
cargo_id integer ID do cargo
PUT /api/v1/colaboradores/{id} Actualizar colaborador

Envie apenas os campos que deseja actualizar.

DELETE /api/v1/colaboradores/{id} Remover colaborador

Esta acção é irreversível. O colaborador será marcado como inactivo.

Vagas

GET /api/v1/vagas Listar todas as vagas
Resposta
{
  "success": true,
  "data": [
    {
      "id": 1,
      "titulo": "Desenvolvedor Full Stack",
      "departamento": "Tecnologia",
      "tipo": "CLT",
      "status": "aberta",
      "candidatos_count": 45
    }
  ]
}
POST /api/v1/vagas Criar nova vaga

Crie uma nova vaga com título, descrição e requisitos.

Férias

GET /api/v1/ferias Listar solicitações de férias
Resposta
{
  "success": true,
  "data": [
    {
      "id": 1,
      "colaborador_id": 15,
      "data_inicio": "2026-04-01",
      "data_fim": "2026-04-15",
      "dias": 15,
      "status": "pendente"
    }
  ]
}
POST /api/v1/ferias Solicitar férias

Crie uma nova solicitação de férias para um colaborador.

PUT /api/v1/ferias/{id}/aprovar Aprovar solicitação

Aprova a solicitação de férias. Requer permissão de gestor.