ISP System - API Documentation

Voltar ao Sistema
Informações Gerais

Base URL:

Autenticação: Bearer Token (JWT)

Formato: JSON

Charset: UTF-8

GET /api/clientes

Lista todos os clientes


GET /api/clientes/{id}

Obtém detalhes de um cliente específico


POST /api/clientes

Cria um novo cliente

{
    "nome_completo": "João Silva",
    "cpf_cnpj": "123.456.789-00",
    "email": "joao@exemplo.com",
    "telefone": "(11) 99999-9999"
}

PUT /api/clientes/{id}

Atualiza um cliente existente


DELETE /api/clientes/{id}

Remove um cliente

GET /api/faturas

Lista todas as faturas


GET /api/faturas/{id}

Obtém detalhes de uma fatura


POST /api/faturas/gerar

Gera uma nova fatura

{
    "cliente_id": 1,
    "valor": 99.90,
    "data_vencimento": "2024-12-31"
}
GET /api/boletos

Lista todos os boletos


GET /api/boletos/{id}/pdf

Download do PDF do boleto


POST /api/boletos/gerar

Gera um novo boleto

{
    "fatura_id": 1,
    "conta_bancaria_id": 1
}
GET /api/mikrotik/servers

Lista servidores MikroTik


GET /api/mikrotik/users/{servidor_id}

Lista usuários PPPoE


GET /api/mikrotik/sessions/{servidor_id}

Lista sessões ativas


POST /api/mikrotik/sync

Sincroniza dados com MikroTik

Autenticação

Para acessar a API, é necessário um token JWT:

Authorization: Bearer {seu_token_jwt}
Obter Token:
POST /api/login
{
    "email": "usuario@exemplo.com",
    "senha": "sua_senha"
}
            
Para testes, utilize o Swagger UI: Swagger UI