PEPINO ZAPdocs

API Reference

Endpoints REST do PEPINO ZAP. Auto-gerado do OpenAPI do Fiber Go quando estiver pronto.

Esta seção será auto-gerada do OpenAPI do Fiber Go quando a API Go estiver pronta. Por enquanto, mostra placeholders com o shape esperado dos endpoints.

Base URL

AmbienteURL
Produçãohttps://api.pepinozap.com
Homologhttps://homolog-api.pepinozap.com
Localhttp://localhost:3010

Convenções

  • Todas as rotas são prefixadas com /v1 exceto /health
  • Auth: header Authorization: Bearer pzk_live_...
  • Erros em envelope padrão:
{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request payload",
    "details": { ... }
  }
}
  • Códigos HTTP:
    • 200 OK / 201 Created
    • 400 Bad Request (VALIDATION_ERROR)
    • 401 Unauthorized (MISSING_API_KEY, INVALID_API_KEY)
    • 403 Forbidden (PROJECT_INACTIVE)
    • 404 Not Found
    • 409 Conflict (ex: instância duplicada)
    • 429 Too Many Requests (RATE_LIMITED)
    • 500 Internal Server Error

Recursos

  • Instâncias — criar, listar, deletar, QR via SSE
  • Mensagens — enviar texto/mídia, status, histórico
  • Webhooks — registrar URL, testar, ver logs

Previous

Rate-limiting

Next

API Reference

On this page