API REST da P8W

API REST para desenvolvedores

A P8W oferece uma API REST completa para integração com sistemas externos, automações e desenvolvimento personalizado.

Autenticação da API

Endpoints principais

Cada módulo (plugin) expõe seus próprios endpoints seguindo o padrão:

• GET /api/{recurso}: Listar registros (com paginação, filtros e ordenação).
• GET /api/{recurso}/{id}: Obter um registro específico.
• POST /api/{recurso}: Criar novo registro.
• PUT /api/{recurso}/{id}: Atualizar registro existente.
• DELETE /api/{recurso}/{id}: Excluir registro.

Formato de resposta

Todas as respostas são em JSON com formato padronizado:

• Sucesso: {"success": true, "data": {...}, "meta": {"page": 1, "total": 50}}
• Erro: {"success": false, "message": "Descrição do erro", "code": 422}

Rate Limiting

A API possui rate limiting configurável. Headers de resposta informam o estado:

• X-RateLimit-Limit: Limite de requisições por janela.
• X-RateLimit-Remaining: Requisições restantes na janela atual.
• X-RateLimit-Reset: Timestamp de reset da janela.

Ao exceder o limite, a API retorna status 429 (Too Many Requests).

Paginação

Endpoints de listagem suportam paginação via query string:

• ?page=2&per_page=25: Página 2 com 25 itens.
• ?sort=created_at&order=desc: Ordenação decrescente por data.
• ?search=termo: Busca textual.

Versionamento

A API é versionada via header ou URL prefix para garantir compatibilidade com integrações existentes.