> ## Documentation Index
> Fetch the complete documentation index at: https://docs.notifique.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Introdução

> Crie conta, assine plano, cadastre cartão e gerencie o workspace via API — tudo que o painel faz, sem abrir o painel.

<Tip>
  Platform API é o **controle remoto do painel**: conta, billing, workspace, webhooks e logs — ideal para agentes de IA e provisionamento automático.
</Tip>

## 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.

<Note>
  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**.
</Note>

## Credenciais no fluxo

| Etapa                         | Credencial                                                  | Uso                                          |
| ----------------------------- | ----------------------------------------------------------- | -------------------------------------------- |
| Após `register`               | `verificationToken` (onboarding)                            | `POST /v1/platform/verify` + OTP do telefone |
| Após `login` com 2FA pendente | `verificationToken` (login\_2fa)                            | `POST /v1/platform/login` + `totpCode`       |
| Após `verify` (registro)      | `apiKey` + `workspaceId`                                    | Toda a API v1                                |
| Login sem 2FA                 | `sessionToken` (+ opcional nova `apiKey` com `workspaceId`) | Billing, `GET /v1/platform/me`               |

Detalhes e fluxo para agentes: [Registro e verificação](/platform-api/como-funciona/registro-e-verificacao).

```http theme={null}
Authorization: Bearer sk_live_xxxxx
```

Alternativa: `x-api-key: sk_live_xxxxx`.

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

| Área       | Rotas principais                                                           | Guia                                                                         |
| ---------- | -------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
| Conta      | `/v1/platform/register`, `/verify`, `/login`                               | [Registro e verificação](/platform-api/como-funciona/registro-e-verificacao) |
| Billing    | `/v1/platform/workspaces/:id/subscription`, `/balance`, `/payment-methods` | [Billing](/platform-api/como-funciona/billing)                               |
| API keys   | `/v1/platform/api-keys`                                                    | [Escopos](/platform-api/como-funciona/escopos-api-key)                       |
| Workspaces | `/v1/workspaces`                                                           | [Workspaces](/platform-api/como-funciona/workspaces)                         |
| Webhooks   | `/v1/webhooks`, `/v1/webhooks/deliveries`                                  | [Webhooks](/platform-api/como-funciona/webhooks)                             |
| Logs       | `/v1/logs`                                                                 | [Logs](/platform-api/como-funciona/logs)                                     |
| OAuth      | `/oauth/*`, `/.well-known/*`                                               | [OAuth](/platform-api/como-funciona/oauth)                                   |

## 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

* [Quick Start](/platform-api/como-funciona/quick-start): do zero à primeira mensagem
* [Registro e verificação](/platform-api/como-funciona/registro-e-verificacao): enums do onboarding e erros de OTP
* [Billing](/platform-api/como-funciona/billing): plano, saldo e cartões
* [Escopos da API Key](/platform-api/como-funciona/escopos-api-key): permissões para integrar