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

# Quick Start

> Do zero à conta verificada, plano assinado e primeira mensagem — sem abrir o painel.

<Tip>
  Este guia leva você da **conta vazia ao primeiro envio**. Tudo via API: registro, OTP, cartão, plano e mensagem.
</Tip>

## Em poucas palavras

1. **Registrar** conta com survey de onboarding (campos com enums fixos)
2. **Verificar** telefone com OTP → recebe `apiKey` (guarde agora)
3. **Opcional:** cadastrar cartão e assinar plano
4. **Enviar** mensagem com a API key nos canais

Enums do onboarding: [Registro e verificação](/platform-api/como-funciona/registro-e-verificacao#survey-de-onboarding).

## 1. Registrar conta

```bash theme={null}
curl -X POST https://api.notifique.dev/v1/platform/register \
  -H "Content-Type: application/json" \
  -d '{
    "email": "dev@empresa.com",
    "password": "SenhaSegura123!",
    "name": "Maria Dev",
    "phone": "5511999999999",
    "onboardingSurvey": {
      "rolePersona": "developer",
      "primaryGoal": "api",
      "plannedChannels": ["whatsapp", "email", "sms"]
    }
  }'
```

Resposta: `verificationToken`, `deliveryChannel` (whatsapp ou sms), `expiresAt`, `retryAfter`.

## 2. Verificar telefone

```bash theme={null}
curl -X POST https://api.notifique.dev/v1/platform/verify \
  -H "Content-Type: application/json" \
  -d '{
    "verificationToken": "<token do passo 1>",
    "code": "123456"
  }'
```

Resposta: `apiKey`, `workspaceId`, `user`. **Guarde a `apiKey`** — ela não é exibida novamente.

## 3. (Opcional) Cadastrar cartão e assinar plano

```bash theme={null}
# Listar plano atual
curl https://api.notifique.dev/v1/platform/workspaces/WORKSPACE_ID/subscription \
  -H "Authorization: Bearer sk_live_..."

# Assinar Basic com cartão já tokenizado
curl -X POST https://api.notifique.dev/v1/platform/workspaces/WORKSPACE_ID/subscription \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "tierIndex": 1,
    "billingType": "CREDIT_CARD",
    "cpfCnpj": "12345678901",
    "mobilePhone": "5511999999999",
    "paymentMethodId": "pm_xxx"
  }'
```

Detalhes de cartão, PIX e recarga: [Billing](/platform-api/como-funciona/billing).

## 4. Enviar primeira mensagem

```bash theme={null}
curl -X POST https://api.notifique.dev/v1/email/messages \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "to": ["cliente@email.com"], "subject": "Olá", "text": "Teste Platform API" }'
```

## Login em conta existente

```bash theme={null}
curl -X POST https://api.notifique.dev/v1/platform/login \
  -H "Content-Type: application/json" \
  -d '{
    "email": "dev@empresa.com",
    "password": "SenhaSegura123!",
    "createApiKey": true,
    "workspaceId": "clws_02H..."
  }'
```

Com **2FA**: o primeiro login devolve `requiresSecondFactor` + `verificationToken`; chame **login de novo** com esse token + `totpCode` (não use `verify`). Detalhes: [Registro e verificação](/platform-api/como-funciona/registro-e-verificacao).

## Segundo workspace

```bash theme={null}
curl -X POST https://api.notifique.dev/v1/workspaces \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{"name": "Homologação", "color": "#3B82F6"}'
```

Depois faça login com `workspaceId` do novo workspace para obter API key nele.

## Idempotency-Key

Em envios (`POST /v1/*/messages`), use header `Idempotency-Key`. Respostas cacheadas incluem `Idempotency-Replayed: true`.

## Próximos passos

* [Webhooks](/platform-api/como-funciona/webhooks): receber eventos no seu servidor
* [Workspaces](/platform-api/como-funciona/workspaces): organizar instâncias e equipe
* [Escopos](/platform-api/como-funciona/escopos-api-key): restringir a chave para produção