Quittar

Quittar API

v1.0.0 production

Documentação gerada a partir das rotas registradas nesta instância — sempre em sincronia com o código. Verifique /api/health para o status do serviço.

Como usar

Multi-tenant

O tenant é resolvido, em ordem de prioridade: subdomínio (acme.cobrixapp.com), header X-Tenant-ID, o client OAuth do token Passport, ou ?tenant_id= (apenas em dev local).

Autenticação

Rotas de usuário usam Sanctum (token opaco via Authorization: Bearer <token>, expira em 24h). Integrações de terceiros usam Passport OAuth2 (Client Credentials) com scopes por recurso.

Rate limiting

Login: 5 tentativas/min por IP. Rotas autenticadas: 60 req/min por usuário. Rotas com limite próprio aparecem com a badge throttle abaixo.

Formato

Todas as rotas abaixo aceitam/retornam JSON. Respostas de erro seguem {"message": "...", "errors": {...}} com mensagens em português.

API Pública (Partners)

Integrações de terceiros via OAuth2 Client Credentials + scopes — clientes, débitos e cobranças.

  • GET
    /api/public/v1/charges OAuth2 Client Credentials + Scope (Passport) public.charges.index
  • GET
    /api/public/v1/clients OAuth2 Client Credentials + Scope (Passport) public.clients.index
  • GET
    /api/public/v1/clients/{id} OAuth2 Client Credentials + Scope (Passport) public.clients.show
  • GET
    /api/public/v1/debts OAuth2 Client Credentials + Scope (Passport) public.debts.index
  • GET
    /api/public/v1/debts/{id} OAuth2 Client Credentials + Scope (Passport) public.debts.show
  • POST
    /api/public/v1/sync/clients OAuth2 Client Credentials + Scope (Passport) throttle:sync public.clients.sync
  • POST
    /api/public/v1/sync/debts OAuth2 Client Credentials + Scope (Passport) throttle:sync public.debts.sync
  • POST
    /api/v1/public/data-deletion-request OAuth2 Client Credentials + Scope (Passport) throttle:5,1 public.data-deletion-request
  • GET
    /api/v1/public/marketing-stats OAuth2 Client Credentials + Scope (Passport) throttle:60,1 public.marketing-stats
  • GET
    /api/v1/public/pricing OAuth2 Client Credentials + Scope (Passport) throttle:60,1 public.pricing

Addon-trials

  • POST
    /api/v1/addon-trials Sanctum (Bearer token de usuário) throttle:api addon-trials.store

Administração Global

Restrito a superadmin: gestão de tenants, usuários de tenants, faturamento consolidado e comprovantes cross-tenant.

  • GET
    /api/v1/admin/backups Sanctum (Bearer token de usuário) admin.backups.index
  • GET
    /api/v1/admin/billing Sanctum (Bearer token de usuário) admin.billing
  • GET
    /api/v1/admin/billing/summary Sanctum (Bearer token de usuário) admin.billing.summary
  • GET
    /api/v1/admin/health/diagnostics Sanctum (Bearer token de usuário) admin.health.diagnostics
  • GET
    /api/v1/admin/helpdesk Sanctum (Bearer token de usuário) throttle:api admin.helpdesk.index
  • GET
    /api/v1/admin/helpdesk/{id} Sanctum (Bearer token de usuário) throttle:api admin.helpdesk.show
  • PATCH
    /api/v1/admin/helpdesk/{id}/extension Sanctum (Bearer token de usuário) throttle:api admin.helpdesk.extension
  • POST
    /api/v1/admin/helpdesk/{id}/messages Sanctum (Bearer token de usuário) throttle:api admin.helpdesk.messages.store
  • GET
    /api/v1/admin/pricing Sanctum (Bearer token de usuário) admin.pricing.index
  • PATCH
    /api/v1/admin/pricing/sms-addon-tiers/{id} Sanctum (Bearer token de usuário) admin.pricing.sms-addon-tiers.update
  • PATCH
    /api/v1/admin/pricing/sms-credit-packages/{id} Sanctum (Bearer token de usuário) admin.pricing.sms-credit-packages.update
  • GET
    /api/v1/admin/receipts Sanctum (Bearer token de usuário) throttle:api admin.receipts.index
  • POST
    /api/v1/admin/receipts/{uuid}/send-email Sanctum (Bearer token de usuário) throttle:api admin.receipts.send-email
  • GET
    /api/v1/admin/tenants Sanctum (Bearer token de usuário) admin.tenants.index
  • GET
    /api/v1/admin/tenants/{id}/invoices Sanctum (Bearer token de usuário) admin.tenants.invoices
  • GET
    /api/v1/admin/tenants/{id}/users Sanctum (Bearer token de usuário) admin.tenants.users
  • PUT
    /api/v1/admin/tenants/{id}/users/{userId} Sanctum (Bearer token de usuário) admin.tenants.users.update
  • POST
    /api/v1/admin/tenants/{id}/users/{userId}/resend-invite Sanctum (Bearer token de usuário) admin.tenants.users.resend-invite

Assinatura

Planos, assinatura atual, faturas, pagamento (Pix/boleto/cartão) e cancelamento.

  • POST
    /api/v1/subscription/add-card Sanctum (Bearer token de usuário) throttle:api subscription.add-card
  • POST
    /api/v1/subscription/cancel Sanctum (Bearer token de usuário) throttle:api subscription.cancel
  • GET
    /api/v1/subscription/current Sanctum (Bearer token de usuário) throttle:api subscription.current
  • GET
    /api/v1/subscription/invoices Sanctum (Bearer token de usuário) throttle:api subscription.invoices
  • GET
    /api/v1/subscription/invoices/{id} Sanctum (Bearer token de usuário) throttle:api subscription.invoices.show
  • POST
    /api/v1/subscription/invoices/{id}/confirm Sanctum (Bearer token de usuário) throttle:api subscription.invoices.confirm
  • POST
    /api/v1/subscription/invoices/{id}/pay-boleto Sanctum (Bearer token de usuário) throttle:api subscription.invoices.pay-boleto
  • POST
    /api/v1/subscription/invoices/{id}/pay-card Sanctum (Bearer token de usuário) throttle:api subscription.invoices.pay-card
  • POST
    /api/v1/subscription/invoices/{id}/pay-pix Sanctum (Bearer token de usuário) throttle:api subscription.invoices.pay-pix
  • GET
    /api/v1/subscription/plans Sanctum (Bearer token de usuário) throttle:api subscription.plans
  • PATCH
    /api/v1/subscription/plans/{planId} Sanctum (Bearer token de usuário) throttle:api subscription.plans.update
  • POST
    /api/v1/subscription/subscribe Sanctum (Bearer token de usuário) throttle:api subscription.subscribe

Autenticação

Login, registro, troca/recuperação de senha, verificação de e-mail e aceite de convite.

  • POST
    /api/v1/auth/accept-invite Público auth.accept-invite
  • POST
    /api/v1/auth/change-password Sanctum (Bearer token de usuário) throttle:api auth.change-password
  • GET
    /api/v1/auth/check-token Público auth.check-token
  • POST
    /api/v1/auth/forgot-password Público (tenant obrigatório, sem login) auth.forgot-password
  • POST
    /api/v1/auth/login Público (tenant obrigatório, sem login) throttle:auth auth.login
  • POST
    /api/v1/auth/logout Sanctum (Bearer token de usuário) throttle:api auth.logout
  • GET
    /api/v1/auth/me Sanctum (Bearer token de usuário) throttle:api auth.me
  • POST
    /api/v1/auth/me/avatar Sanctum (Bearer token de usuário) throttle:api auth.avatar.upload
  • POST
    /api/v1/auth/refresh Sanctum (Bearer token de usuário) throttle:api auth.refresh
  • POST
    /api/v1/auth/register Sanctum (Bearer token de usuário) throttle:api auth.register
  • POST
    /api/v1/auth/resend-verification Público auth.resend-verification
  • POST
    /api/v1/auth/reset-password Público auth.reset-password
  • POST
    /api/v1/auth/verify-email Público auth.verify-email

Automação

Regras de automação por dias antes/depois do vencimento, histórico de execuções e clonagem.

  • GET
    /api/v1/automation Sanctum (Bearer token de usuário) throttle:api automation.index
  • GET
    /api/v1/automation/history Sanctum (Bearer token de usuário) throttle:api automation.history
  • GET
    /api/v1/automation/{id} Sanctum (Bearer token de usuário) throttle:api automation.show
  • POST
    /api/v1/automation/{id}/clone Sanctum (Bearer token de usuário) throttle:api automation.clone
  • PATCH
    /api/v1/automation/{id}/toggle Sanctum (Bearer token de usuário) throttle:api automation.toggle

Banks

  • GET
    /api/v1/banks Sanctum (Bearer token de usuário) throttle:api banks.index

Boletos

Emissão, consulta, sincronização, cancelamento e retorno CNAB de boletos.

  • GET
    /api/v1/boletos Sanctum (Bearer token de usuário) throttle:api boletos.index
  • POST
    /api/v1/boletos/cnab-retorno Sanctum (Bearer token de usuário) throttle:api boletos.cnab-retorno
  • GET
    /api/v1/boletos/gateways-disponiveis Sanctum (Bearer token de usuário) throttle:api boletos.gateways-disponiveis
  • GET
    /api/v1/boletos/tipos-suportados Sanctum (Bearer token de usuário) throttle:api boletos.tipos-suportados
  • GET
    /api/v1/boletos/{id} Sanctum (Bearer token de usuário) throttle:api boletos.show
  • PATCH
    /api/v1/boletos/{id}/atualizar-valor Sanctum (Bearer token de usuário) throttle:api boletos.atualizar-valor
  • PATCH
    /api/v1/boletos/{id}/cancel Sanctum (Bearer token de usuário) throttle:api boletos.cancel
  • PATCH
    /api/v1/boletos/{id}/sync Sanctum (Bearer token de usuário) throttle:api boletos.sync

Clientes

CRUD de clientes do tenant, importação em massa via CSV e consulta de CEP.

  • GET
    /api/v1/clients Sanctum (Bearer token de usuário) throttle:api clients.index
  • POST
    /api/v1/clients/import Sanctum (Bearer token de usuário) throttle:api clients.import
  • GET
    /api/v1/clients/import/{id} Sanctum (Bearer token de usuário) throttle:api clients.import.status
  • GET
    /api/v1/clients/{id} Sanctum (Bearer token de usuário) throttle:api clients.show

Cobranças

Consulta das cobranças (mensagens) disparadas por débito e canal.

  • GET
    /api/v1/charges Sanctum (Bearer token de usuário) throttle:api charges.index
  • GET
    /api/v1/charges/{id} Sanctum (Bearer token de usuário) throttle:api charges.show

Comprovantes

Consulta e reenvio por e-mail de comprovantes de pagamento.

  • GET
    /api/v1/receipts Sanctum (Bearer token de usuário) throttle:api receipts.index
  • GET
    /api/v1/receipts/{receipt} Sanctum (Bearer token de usuário) throttle:api receipts.show
  • POST
    /api/v1/receipts/{receipt}/send-email Sanctum (Bearer token de usuário) throttle:api receipts.send-email
  • GET
    /api/v1/receipts/{uuid}/view Público receipts.view

Configurações do Tenant

Dados da empresa, logotipo, teste de SMTP/SMS/WhatsApp (Evolution API) e verificação de domínio.

  • POST
    /api/v1/tenant/evolution/instance Sanctum (Bearer token de usuário) throttle:api tenant.evolution.instance.create
  • GET
    /api/v1/tenant/evolution/instance/status Sanctum (Bearer token de usuário) throttle:api tenant.evolution.instance.status
  • POST
    /api/v1/tenant/logo Sanctum (Bearer token de usuário) throttle:api tenant.logo.upload
  • PATCH
    /api/v1/tenant/settings Sanctum (Bearer token de usuário) throttle:api tenant.settings.update
  • POST
    /api/v1/tenant/smtp/setup-sender Sanctum (Bearer token de usuário) throttle:api tenant.smtp.setup-sender
  • POST
    /api/v1/tenant/smtp/test-sender Sanctum (Bearer token de usuário) throttle:api tenant.smtp.test-sender
  • POST
    /api/v1/tenant/test-evolution Sanctum (Bearer token de usuário) throttle:api tenant.test-evolution
  • POST
    /api/v1/tenant/test-sms Sanctum (Bearer token de usuário) throttle:api tenant.test-sms
  • POST
    /api/v1/tenant/test-smtp Sanctum (Bearer token de usuário) throttle:api tenant.test-smtp
  • POST
    /api/v1/tenant/verify-domain Sanctum (Bearer token de usuário) throttle:api tenant.verify-domain

Dashboard

Métricas consolidadas de cobrança (total em aberto, inadimplentes, recuperado, taxa de recuperação) e exportação CSV.

  • GET
    /api/v1/dashboard Sanctum (Bearer token de usuário) throttle:api dashboard.index
  • GET
    /api/v1/dashboard/export-csv Sanctum (Bearer token de usuário) throttle:api dashboard.export-csv

Débitos

CRUD de débitos, marcação de pagamento/cancelamento e geração de link do Portal do Devedor.

  • GET
    /api/v1/debts Sanctum (Bearer token de usuário) throttle:api debts.index
  • GET
    /api/v1/debts/{id} Sanctum (Bearer token de usuário) throttle:api debts.show
  • PATCH
    /api/v1/debts/{id}/cancel Sanctum (Bearer token de usuário) throttle:api debts.cancel
  • PATCH
    /api/v1/debts/{id}/paid Sanctum (Bearer token de usuário) throttle:api debts.paid

Faturamento (SaaS)

Resumo e faturas da assinatura SaaS do tenant, e upgrade de plano.

  • GET
    /api/v1/billing/invoices Sanctum (Bearer token de usuário) throttle:api billing.invoices
  • GET
    /api/v1/billing/summary Sanctum (Bearer token de usuário) throttle:api billing.summary
  • POST
    /api/v1/billing/upgrade Sanctum (Bearer token de usuário) throttle:api billing.upgrade

Gamificação / Recompensas

Regras de recompensa e conquistas — desconto na mensalidade por metas de recuperação atingidas.

  • GET
    /api/v1/gamification/achievements Sanctum (Bearer token de usuário) throttle:api gamification.achievements.index
  • GET
    /api/v1/gamification/achievements/admin Sanctum (Bearer token de usuário) throttle:api gamification.achievements.admin
  • GET
    /api/v1/gamification/achievements/progress Sanctum (Bearer token de usuário) throttle:api gamification.achievements.progress
  • GET
    /api/v1/gamification/rules Sanctum (Bearer token de usuário) throttle:api gamification.rules.index
  • PUT
    /api/v1/gamification/rules/{id} Sanctum (Bearer token de usuário) throttle:api gamification.rules.update
  • PATCH
    /api/v1/gamification/rules/{id}/restore Sanctum (Bearer token de usuário) throttle:api gamification.rules.restore

Gateways de Pagamento

Cadastro, teste de conexão e gateway padrão do tenant (Asaas, Mercado Pago, Cielo, Inter e outros).

  • GET
    /api/v1/payment-gateways Sanctum (Bearer token de usuário) throttle:api gateways.index
  • GET
    /api/v1/payment-gateways/schema/{tipo} Sanctum (Bearer token de usuário) throttle:api gateways.schema
  • GET
    /api/v1/payment-gateways/{id} Sanctum (Bearer token de usuário) throttle:api gateways.show
  • POST
    /api/v1/payment-gateways/{id}/set-default Sanctum (Bearer token de usuário) throttle:api gateways.set-default
  • POST
    /api/v1/payment-gateways/{id}/test Sanctum (Bearer token de usuário) throttle:api gateways.test

Gateways de Pagamento (alias)

Mesmo recurso de Gateways de Pagamento, exposto em /api/v1/gateways — usado pelo frontend web.

  • GET
    /api/v1/gateways Sanctum (Bearer token de usuário) throttle:api gateways-v2.index
  • GET
    /api/v1/gateways/schema/{tipo} Sanctum (Bearer token de usuário) throttle:api gateways-v2.schema
  • GET
    /api/v1/gateways/{id} Sanctum (Bearer token de usuário) throttle:api gateways-v2.show
  • POST
    /api/v1/gateways/{id}/certificado Sanctum (Bearer token de usuário) throttle:api gateways-v2.certificado
  • POST
    /api/v1/gateways/{id}/default Sanctum (Bearer token de usuário) throttle:api gateways-v2.default
  • POST
    /api/v1/gateways/{id}/test Sanctum (Bearer token de usuário) throttle:api gateways-v2.test

Generated::0fOdPu8HEoRjokbn

  • GET
    /api/portal/v1/{token}/charge/status Público throttle:portal-view generated::0fOdPu8HEoRjokbn

Generated::6esVZWVlceGdUxmc

  • POST
    /api/portal/v1/{token}/negotiate Público throttle:portal-billing generated::6esVZWVlceGdUxmc

Generated::AR5p0MgFjVwZmtFt

  • GET
    /api/portal/v1/{token} Público throttle:portal-view generated::AR5p0MgFjVwZmtFt

Generated::CwxQhwaHmExF94pJ

  • POST
    /api/portal/v1/{token}/charge Público throttle:portal-billing generated::CwxQhwaHmExF94pJ

Generated::IvY7QPxZKXjwB5xJ

  • PUT
    /api/portal/v1/{token}/client Público throttle:portal-billing generated::IvY7QPxZKXjwB5xJ

Generated::S2rwnJOQejyVinp1

  • POST
    /api/portal/v1/{token}/boletos/{boletoId}/reportar-pagamento Público throttle:portal-billing generated::S2rwnJOQejyVinp1

Generated::SPuJeuuKwnzali5a

  • PATCH
    /api/v1/proposals/{id}/reject Sanctum (Bearer token de usuário) generated::SPuJeuuKwnzali5a

Generated::YwVE7xNGovNhiHI3

  • GET
    /api/user Sanctum (Bearer token de usuário) generated::YwVE7xNGovNhiHI3

Generated::hgJQtZSL7M9Birzg

  • PATCH
    /api/v1/proposals/{id}/accept Sanctum (Bearer token de usuário) generated::hgJQtZSL7M9Birzg

Generated::iKBRuqwYr2hRyWmi

  • GET
    /api/v1/proposals Sanctum (Bearer token de usuário) generated::iKBRuqwYr2hRyWmi

Generated::q6DfFqSv6bXRnKB6

  • GET
    /api/portal/v1/{token}/cep/{zip} Público throttle:portal-view generated::q6DfFqSv6bXRnKB6

Generated::qPutgbmFhyJ7euGz

  • POST
    /api/v1/debts/{id}/portal-token Sanctum (Bearer token de usuário) generated::qPutgbmFhyJ7euGz

Generated::wvqww9pu8cNeG8m1

  • GET
    /api/portal/v1/{token}/proposal Público throttle:portal-view generated::wvqww9pu8cNeG8m1

Generated::zOOKjGfUNbCBGB1a

  • GET
    /api/portal/v1/{token}/history Público throttle:portal-view generated::zOOKjGfUNbCBGB1a

Health Check

Verificação pública de saúde da API — sem tenant, sem autenticação.

  • GET
    /api/health Público throttle:60,1 health

Helpdesk

  • GET
    /api/v1/helpdesk Sanctum (Bearer token de usuário) throttle:api helpdesk.index
  • GET
    /api/v1/helpdesk/attachments/{uuid}/download Sanctum (Bearer token de usuário) throttle:api helpdesk.attachments.download
  • GET
    /api/v1/helpdesk/{id} Sanctum (Bearer token de usuário) throttle:api helpdesk.show
  • GET
    /api/v1/helpdesk/{id}/messages Sanctum (Bearer token de usuário) throttle:api helpdesk.messages.index

Integrations

  • GET
    /api/v1/integrations/webhook Sanctum (Bearer token de usuário) throttle:api integrations.webhook.show
  • GET
    /api/v1/integrations/webhook/deliveries Sanctum (Bearer token de usuário) throttle:api integrations.webhook.deliveries
  • POST
    /api/v1/integrations/webhook/rotate-secret Sanctum (Bearer token de usuário) throttle:api integrations.webhook.rotate-secret

Notificações

Notificações internas do usuário e registro de device token para push.

  • GET
    /api/v1/notifications Sanctum (Bearer token de usuário) throttle:api notifications.index
  • POST
    /api/v1/notifications/device-token Sanctum (Bearer token de usuário) throttle:api notifications.device-token.store
  • POST
    /api/v1/notifications/device-token/test Sanctum (Bearer token de usuário) throttle:api notifications.device-token.test
  • POST
    /api/v1/notifications/read-all Sanctum (Bearer token de usuário) throttle:api notifications.read-all
  • GET
    /api/v1/notifications/unread-count Sanctum (Bearer token de usuário) throttle:api notifications.unread-count
  • PATCH
    /api/v1/notifications/{id}/read Sanctum (Bearer token de usuário) throttle:api notifications.read

OAuth2

Gestão de clients OAuth2 e consentimento (Authorization Code) para integrações de terceiros.

  • GET
    /api/v1/oauth/authorize Sanctum (Bearer token de usuário) oauth.authorize
  • GET
    /api/v1/oauth/clients Sanctum (Bearer token de usuário) oauth.clients.index
  • DELETE
    /api/v1/oauth/clients/{client} Sanctum (Bearer token de usuário) oauth.clients.destroy
  • GET
    /api/v1/oauth/scopes Sanctum (Bearer token de usuário) oauth.scopes

Onboarding

  • POST
    /api/v1/onboarding/dismiss Sanctum (Bearer token de usuário) throttle:api onboarding.dismiss
  • POST
    /api/v1/onboarding/nps Sanctum (Bearer token de usuário) throttle:api onboarding.nps.submit
  • GET
    /api/v1/onboarding/nps/status Sanctum (Bearer token de usuário) throttle:api onboarding.nps.status
  • GET
    /api/v1/onboarding/progress Sanctum (Bearer token de usuário) throttle:api onboarding.show
  • POST
    /api/v1/onboarding/steps/{step}/complete Sanctum (Bearer token de usuário) throttle:api onboarding.steps.complete

Pix-confirmations

  • GET
    /api/v1/pix-confirmations Sanctum (Bearer token de usuário) throttle:api pix-confirmations.index
  • POST
    /api/v1/pix-confirmations/{id}/confirmar Sanctum (Bearer token de usuário) throttle:api pix-confirmations.confirmar
  • POST
    /api/v1/pix-confirmations/{id}/rejeitar Sanctum (Bearer token de usuário) throttle:api pix-confirmations.rejeitar

Privacy

  • GET
    /api/v1/privacy/export Sanctum (Bearer token de usuário) throttle:api privacy.export.own
  • GET
    /api/v1/privacy/export/clients/{id} Sanctum (Bearer token de usuário) throttle:api privacy.export.client
  • POST
    /api/v1/privacy/request-deletion Sanctum (Bearer token de usuário) throttle:api privacy.request-deletion

Promoções

Cupons de desconto aplicáveis à assinatura do tenant.

  • GET
    /api/v1/promotions Sanctum (Bearer token de usuário) throttle:api promotions.index
  • GET
    /api/v1/promotions/active Sanctum (Bearer token de usuário) throttle:api promotions.active
  • POST
    /api/v1/promotions/apply Sanctum (Bearer token de usuário) throttle:api promotions.apply
  • GET
    /api/v1/promotions/{id} Sanctum (Bearer token de usuário) throttle:api promotions.show
  • PATCH
    /api/v1/promotions/{id}/restore Sanctum (Bearer token de usuário) throttle:api promotions.restore

Rastreamento de E-mail

Pixel de rastreamento de abertura de e-mail enviado pela Automação.

  • GET
    /api/email/pixel/{uuid} Público email.pixel

Registro de Conta

Criação de uma nova conta/tenant (self-service) e verificação de subdomínio disponível.

  • GET
    /api/v1/check-cep/{zip} Público throttle:30,1 registration.check-cep
  • GET
    /api/v1/check-subdomain Público throttle:30,1 registration.check-subdomain
  • POST
    /api/v1/register Público throttle:10,1 registration.store

Sms-addon

  • DELETE
    /api/v1/sms-addon Sanctum (Bearer token de usuário) throttle:api sms-addon.cancel
  • POST
    /api/v1/sms-addon/activate Sanctum (Bearer token de usuário) throttle:api sms-addon.activate
  • GET
    /api/v1/sms-addon/tiers Sanctum (Bearer token de usuário) throttle:api sms-addon.tiers

Sms-credits

  • GET
    /api/v1/sms-credits/packages Sanctum (Bearer token de usuário) throttle:api sms-credits.packages
  • POST
    /api/v1/sms-credits/purchase Sanctum (Bearer token de usuário) throttle:api sms-credits.purchase
  • GET
    /api/v1/sms-credits/{id} Sanctum (Bearer token de usuário) throttle:api sms-credits.status

Templates

Templates de mensagem por canal (WhatsApp, SMS, e-mail) com pré-visualização.

  • GET
    /api/v1/templates Sanctum (Bearer token de usuário) throttle:api templates.index
  • GET
    /api/v1/templates/metrics Sanctum (Bearer token de usuário) throttle:api templates.metrics.bulk
  • GET
    /api/v1/templates/{id} Sanctum (Bearer token de usuário) throttle:api templates.show
  • GET
    /api/v1/templates/{id}/metrics Sanctum (Bearer token de usuário) throttle:api templates.metrics
  • GET
    /api/v1/templates/{id}/preview Sanctum (Bearer token de usuário) throttle:api templates.preview
  • POST
    /api/v1/templates/{id}/test-send Sanctum (Bearer token de usuário) throttle:api templates.test-send
  • GET
    /api/v1/templates/{id}/versions Sanctum (Bearer token de usuário) throttle:api templates.versions
  • POST
    /api/v1/templates/{id}/versions/{version}/restore Sanctum (Bearer token de usuário) throttle:api templates.versions.restore

Usuários

Convite, edição, habilitar/desabilitar e reenvio de convite para usuários do tenant.

  • GET
    /api/v1/users Sanctum (Bearer token de usuário) throttle:api users.index
  • POST
    /api/v1/users/invite Sanctum (Bearer token de usuário) throttle:api users.invite
  • PUT
    /api/v1/users/{id} Sanctum (Bearer token de usuário) throttle:api users.update
  • PATCH
    /api/v1/users/{id}/disable Sanctum (Bearer token de usuário) throttle:api users.disable
  • PATCH
    /api/v1/users/{id}/enable Sanctum (Bearer token de usuário) throttle:api users.enable
  • POST
    /api/v1/users/{id}/resend-invite Sanctum (Bearer token de usuário) throttle:api users.resendInvite

Vendor-contracts

  • GET
    /api/v1/vendor-contracts Sanctum (Bearer token de usuário) throttle:api vendor-contracts.index-all
  • GET
    /api/v1/vendors/{vendorId}/vendor-contracts Sanctum (Bearer token de usuário) throttle:api vendor-contracts.index
  • GET
    /api/v1/vendors/{vendorId}/vendor-contracts/{id} Sanctum (Bearer token de usuário) throttle:api vendor-contracts.show
  • POST
    /api/v1/vendors/{vendorId}/vendor-contracts/{id}/attachments Sanctum (Bearer token de usuário) throttle:api vendor-contracts.attachments.store
  • DELETE
    /api/v1/vendors/{vendorId}/vendor-contracts/{id}/attachments/{attachmentId} Sanctum (Bearer token de usuário) throttle:api vendor-contracts.attachments.destroy
  • GET
    /api/v1/vendors/{vendorId}/vendor-contracts/{id}/attachments/{attachmentId}/download Sanctum (Bearer token de usuário) throttle:api vendor-contracts.attachments.download
  • PATCH
    /api/v1/vendors/{vendorId}/vendor-contracts/{id}/renew Sanctum (Bearer token de usuário) throttle:api vendor-contracts.renew

Vendor-documents

  • GET
    /api/v1/vendor-documents Sanctum (Bearer token de usuário) throttle:api vendor-documents.index-all
  • GET
    /api/v1/vendors/{vendorId}/vendor-documents Sanctum (Bearer token de usuário) throttle:api vendor-documents.index
  • GET
    /api/v1/vendors/{vendorId}/vendor-documents/{id} Sanctum (Bearer token de usuário) throttle:api vendor-documents.show
  • POST
    /api/v1/vendors/{vendorId}/vendor-documents/{id}/attachments Sanctum (Bearer token de usuário) throttle:api vendor-documents.attachments.store
  • DELETE
    /api/v1/vendors/{vendorId}/vendor-documents/{id}/attachments/{attachmentId} Sanctum (Bearer token de usuário) throttle:api vendor-documents.attachments.destroy
  • GET
    /api/v1/vendors/{vendorId}/vendor-documents/{id}/attachments/{attachmentId}/download Sanctum (Bearer token de usuário) throttle:api vendor-documents.attachments.download

Vendor-invoices

  • GET
    /api/v1/vendor-invoices Sanctum (Bearer token de usuário) throttle:api vendor-invoices.index-all
  • GET
    /api/v1/vendors/{vendorId}/vendor-invoices Sanctum (Bearer token de usuário) throttle:api vendor-invoices.index
  • GET
    /api/v1/vendors/{vendorId}/vendor-invoices/{id} Sanctum (Bearer token de usuário) throttle:api vendor-invoices.show
  • PATCH
    /api/v1/vendors/{vendorId}/vendor-invoices/{id}/approve Sanctum (Bearer token de usuário) throttle:api vendor-invoices.approve
  • POST
    /api/v1/vendors/{vendorId}/vendor-invoices/{id}/attachments Sanctum (Bearer token de usuário) throttle:api vendor-invoices.attachments.store
  • GET
    /api/v1/vendors/{vendorId}/vendor-invoices/{id}/attachments/{attachmentId}/download Sanctum (Bearer token de usuário) throttle:api vendor-invoices.attachments.download
  • PATCH
    /api/v1/vendors/{vendorId}/vendor-invoices/{id}/mark-paid Sanctum (Bearer token de usuário) throttle:api vendor-invoices.mark-paid
  • PATCH
    /api/v1/vendors/{vendorId}/vendor-invoices/{id}/reject Sanctum (Bearer token de usuário) throttle:api vendor-invoices.reject

Vendors

  • GET
    /api/v1/vendors Sanctum (Bearer token de usuário) throttle:api vendors.index
  • GET
    /api/v1/vendors/compliance-report Sanctum (Bearer token de usuário) throttle:api vendors.compliance-report
  • GET
    /api/v1/vendors/{id} Sanctum (Bearer token de usuário) throttle:api vendors.show
  • PATCH
    /api/v1/vendors/{id}/rating Sanctum (Bearer token de usuário) throttle:api vendors.rate

Webhooks (Callbacks Externos)

Callbacks de gateways de pagamento, provedores de SMS e da Evolution API (WhatsApp) — validados por assinatura/segredo do provedor, sem Sanctum/Passport.

  • POST
    /api/webhooks/gateway/{gatewayId} Público (validado por assinatura/segredo do provedor) webhook.gateway
  • POST
    /api/webhooks/sms/brevo Público (validado por assinatura/segredo do provedor) webhooks.sms.brevo
  • POST
    /api/webhooks/sms/smsdev Público (validado por assinatura/segredo do provedor) webhooks.sms.smsdev
  • POST
    /api/webhooks/sms/sns Público (validado por assinatura/segredo do provedor) webhooks.sms.sns
  • POST
    /api/webhooks/sms/twilio Público (validado por assinatura/segredo do provedor) webhooks.sms.twilio
  • POST
    /api/whatsapp/webhook Público (validado por assinatura/segredo do provedor) webhooks.evolution