Skip to main content
Platform API é o controle remoto do painel: conta, billing, workspace, webhooks e logs — ideal para agentes de IA e provisionamento automático.

​
O que é Platform na Notifique?

É a API para operar a conta e o workspace sem interface gráfica. Um agente de IA ou script pode:
  • Criar conta e confirmar telefone por OTP
  • Fazer login e obter API key ou sessão
  • Assinar plano, cancelar, fazer upgrade e recarregar saldo
  • Cadastrar e listar cartões de crédito
  • Criar API keys com escopos restritos
  • Gerenciar workspace (nome, defaults, inbound)
  • Configurar webhooks e consultar entregas
  • Auditar chamadas via logs da API
  • Conectar apps de terceiros com OAuth 2.1
Pense no painel web como o app do banco no celular; a Platform API é o mesmo banco, só que por HTTP.
Envio de mensagens (WhatsApp, SMS, e-mail…) usa as APIs de canal com a apiKey que você obtém aqui. Platform cuida da conta; canal cuida da mensageria.

​
Credenciais no fluxo

Detalhes e fluxo para agentes: Registro e verificação.
Alternativa: x-api-key: sk_live_xxxxx.

​
O que você pode fazer (mapa rápido)

​
Fluxo típico (agente de IA)

  1. POST /v1/platform/register — dados + survey de onboarding (enums validados)
  2. POST /v1/platform/verify — código OTP → apiKey + workspaceId
  3. POST /v1/platform/workspaces/:id/payment-methods — tokeniza cartão
  4. POST /v1/platform/workspaces/:id/subscription — assina Basic/Pro/Business
  5. POST /v1/whatsapp/messages (ou outro canal) com a API key

​
Próximos passos