Skip to main content
POST
/
api
/
auth
/
login
curl -X POST https://api.disparador.com/api/auth/login \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "password": "senha123"
  }'

{
  "accessToken": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "tokenType": "Access",
  "companyId": 1,
  "companyName": "Minha Empresa LTDA",
  "companyEmail": "[email protected]",
  "blockedContactsEnabled": true,
  "pollCampaignsEnabled": true,
  "automationsEnabled": true,
  "automationLimit": 10,
  "subscriptionId": "SUB123456",
  "payerId": "PAY789012",
  "subscriptionStatus": "active",
  "subscriptionReason": "Plano Profissional",
  "externalReference": "REF345678",
  "preapprovalPlanId": "PLAN901234",
  "subscriptionStartDate": "2024-01-15T10:00:00",
  "nextPaymentDate": "2024-02-15T10:00:00",
  "collectorId": "COL567890",
  "subscriptionInitPoint": "point_initial_charge",
  "transactionAmount": "99.90",
  "frequencyType": "monthly",
  "expiresAt": null,
  "message": null
}
O token retornado não expira automaticamente e deve ser usado em todas as requisições subsequentes.

​
Body

​
email
string
required
Email da empresa cadastrada
​
password
string
required
Senha da empresa (mínimo 6 caracteres)
curl -X POST https://api.disparador.com/api/auth/login \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "password": "senha123"
  }'

​
Response

​
Campos Principais

​
accessToken
string
Token de acesso único para autenticação. Use no header X-Access-Token
​
tokenType
string
Tipo do token. Sempre retorna “Access”
​
companyId
number
ID único da empresa no sistema
​
companyName
string
Nome da empresa cadastrada
​
companyEmail
string
Email da empresa
​
expiresAt
string
Data de expiração do token. Sempre null (tokens não expiram)
​
message
string
Mensagem de erro. Null em caso de sucesso

​
Funcionalidades Habilitadas

​
blockedContactsEnabled
boolean
Indica se a funcionalidade de bloqueio inteligente está habilitada
​
pollCampaignsEnabled
boolean
Indica se a funcionalidade de enquetes está habilitada
​
automationsEnabled
boolean
Indica se a funcionalidade de automações está habilitada
​
automationLimit
number
Limite de automações permitidas para a empresa

​
Informações de Assinatura

​
subscriptionId
string
ID da assinatura ativa (se houver)
​
payerId
string
ID do pagador da assinatura
​
subscriptionStatus
string
Status atual da assinatura (active, paused, cancelled, etc.)
​
subscriptionReason
string
Motivo ou descrição da assinatura
​
externalReference
string
Referência externa da assinatura
​
preapprovalPlanId
string
ID do plano de assinatura
​
subscriptionStartDate
string
Data de início da assinatura
​
nextPaymentDate
string
Data do próximo pagamento
​
collectorId
string
ID do coletor de pagamento
​
subscriptionInitPoint
string
Ponto de início da assinatura
​
transactionAmount
string
Valor da transação
​
frequencyType
string
Tipo de frequência de pagamento (monthly, yearly, etc.)
{
  "accessToken": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "tokenType": "Access",
  "companyId": 1,
  "companyName": "Minha Empresa LTDA",
  "companyEmail": "[email protected]",
  "blockedContactsEnabled": true,
  "pollCampaignsEnabled": true,
  "automationsEnabled": true,
  "automationLimit": 10,
  "subscriptionId": "SUB123456",
  "payerId": "PAY789012",
  "subscriptionStatus": "active",
  "subscriptionReason": "Plano Profissional",
  "externalReference": "REF345678",
  "preapprovalPlanId": "PLAN901234",
  "subscriptionStartDate": "2024-01-15T10:00:00",
  "nextPaymentDate": "2024-02-15T10:00:00",
  "collectorId": "COL567890",
  "subscriptionInitPoint": "point_initial_charge",
  "transactionAmount": "99.90",
  "frequencyType": "monthly",
  "expiresAt": null,
  "message": null
}

​
Próximos Passos

Após obter o access token:
  1. Armazene o token com segurança - Use variáveis de ambiente ou storage seguro
  2. Use o token em todas as requisições - Adicione no header X-Access-Token
  3. Verifique a validade - Use o endpoint /api/auth/me para validar o token

Verificar Token

Verifique se seu token está válido
⌘I