Obsidian
Voltar para Documentação

API Reference

API REST completa. Autenticação via Bearer token (JWT).

Base URL: https://cloaker-api.forgedigitalgroup.com.br

Auth Header: Authorization: Bearer <access_token>

Autenticação

POST/api/auth/loginLogin com email e senha. Retorna access + refresh tokens.
POST/api/auth/signupCriar conta. Auto-assign trial de 7 dias no plano Starter.
POST/api/auth/refreshRenovar access token usando refresh token.
POST/api/auth/verify-emailVerificar email com token enviado por email.
POST/api/auth/forgot-passwordSolicitar link de reset de senha.
POST/api/auth/reset-passwordDefinir nova senha com token de reset.

Campanhas

GET/api/campaignsListar campanhas do usuário autenticado.
POST/api/campaignsCriar nova campanha (verifica limite do plano).
GET/api/campaigns/:idDetalhes de uma campanha.
PUT/api/campaigns/:idAtualizar campanha.
DELETE/api/campaigns/:idDeletar campanha.
POST/api/campaigns/:id/toggleAtivar/pausar campanha.

Domínios

GET/api/domainsListar domínios do usuário.
POST/api/domainsAdicionar domínio (verifica limite do plano).
DELETE/api/domains/:idRemover domínio.
POST/api/domains/:id/verifyVerificar DNS do domínio.

Billing

GET/api/billing/plansListar planos disponíveis (público).
GET/api/billing/subscriptionSubscription atual do usuário.
GET/api/billing/usageUso do mês atual (requests vs limite).
GET/api/billing/invoicesHistórico de faturas.
POST/api/billing/checkoutCriar sessão de checkout (Stripe).
POST/api/billing/portalCriar sessão do portal Stripe.

Analytics

GET/api/analytics/statsEstatísticas gerais (total requests, blocked, allowed).
GET/api/analytics/timelineTimeline de requests por hora/dia.
GET/api/analytics/decisionsDistribuição de decisões do filtro.
GET/api/analytics/scoresDistribuição de scores de risco.

Rate Limits

  • Signup / Forgot Password: 5 requests por IP por hora
  • Login: 10 requests por IP por minuto
  • API geral: 100 requests por minuto (autenticado)