arrobaMail
Testar grátis
Módulo 012 endpoints

Auth /auth

Endpoints

2 no total
POST/auth/getTokenPúblico

Obter token JWT

Endpoint público. Não exige autenticação prévia. O token JWT deve ser enviado nas requisições seguintes. Suporta rate limiting por IP e username.

Request body · application/json

NomeTipoObrig.Descrição
usernamestringSimUsuário ou email da conta
passstringSimSenha
rememberMebooleanNãoSe for true, o token dura até 365 dias. Default: false
localestringNãoCódigo de idioma: "en" ou "es". Default: "es"

Exemplo

curl -X POST "https://envios.arrobamail.com/v3/api/auth/getToken" \
  -H "Content-Type: application/json" \
  -d '{
  "username": "...",
  "pass": "...",
  "rememberMe": true,
  "locale": "..."
}'

Resposta 200

{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "user": {
    "id": 1234,
    "uname": "usuario_ejemplo",
    "email": "[email protected]",
    "role": "user",
    "lang": "es"
  }
}

Erros

StatusCodeDescrição
500rate_limitUsuário ou IP bloqueado por exceder o rate limit
412account_suspendedA conta está suspensa
404invalid_credentialsCredenciais inválidas
POST/auth/logoutUsuário

Encerrar sessão e invalidar token

Invalida o token JWT atual. Requer autenticação.

Exemplo

curl -X POST "https://envios.arrobamail.com/v3/api/auth/logout" \
  -H "Authorization: Bearer $TOKEN"

Resposta 200

{
  "status": "ok",
  "message": "Sessão encerrada com sucesso"
}

Erros

StatusCodeDescrição
400token_not_foundToken não encontrado
401invalid_tokenToken inválido ou expirado

Notas de integração · da experiência real

  • A autenticação é por JWT, não por API Key. O token vem de POST /auth/getToken com username + pass (o campo é pass, não password). A “API Key” do painel é outro mecanismo e não autentica esse REST v3.
  • getToken é público e com rate limiting por IP e username. rememberMe: true estende o token até 365 dias; senão, dura a sessão.
  • 401 transitório em operações mutantes. Sob alta concorrência, um PUT/DELETE pode responder 401 por um guard antifraude. Renove o token com um novo getToken e tente novamente.

Comece com o arrobaMail
em menos de 5 minutos.

Plano Gratuito, gerações de IA incluídas, sem cartão de crédito e suporte real em português.

Testar grátis agora
WhatsAppA equipe responde