REST API v1

Documentação da API REST para Desenvolvedores

Crie caixas descartáveis programaticamente e extraia códigos OTP ou magic links. Requer um plano Premium ativo — veja Preços.

1. Autenticação

Autentique toda requisição com sua chave de API secreta no cabeçalho X-API-Key. Gere uma chave no seu painel.

X-API-Key: khml_live_9f87a6b5c4d3e2f10987
Exemplo de código:
POST/api/developers/aliases/

Cria uma nova caixa descartável para sua conta.

curl -X POST "https://api.zephbox.com/api/developers/aliases/" \
  -H "X-API-Key: YOUR_API_KEY"
        
const res = await fetch('https://api.zephbox.com/api/developers/aliases/', {
  method: 'POST',
  headers: { 'X-API-Key': 'YOUR_API_KEY' }
});
const alias = await res.json();
console.log('Address:', alias.email);
        
import requests

headers = {'X-API-Key': 'YOUR_API_KEY'}
res = requests.post('https://api.zephbox.com/api/developers/aliases/', headers=headers)
print(res.json()['email'])

Resposta

{
  "id": 4821,
  "alias": "x7k2p9",
  "email": "[email protected]",
  "is_expired": false,
  "time_remaining": 86400,
  "message_count": 0
}
GET/api/developers/aliases/{alias}/otp/

Extrai um código de verificação ou magic link da mensagem mais recente do alias. Retorna a mensagem mais recente com code/link como null se nada corresponder — nunca um 404 simples depois que a mensagem chegou.

curl -X GET "https://api.zephbox.com/api/developers/aliases/x7k2p9/otp/" \
  -H "X-API-Key: YOUR_API_KEY"
        
const res = await fetch('https://api.zephbox.com/api/developers/aliases/x7k2p9/otp/', {
  headers: { 'X-API-Key': 'YOUR_API_KEY' }
});
const { code, link } = await res.json();
console.log('Code:', code);
        
import requests

headers = {'X-API-Key': 'YOUR_API_KEY'}
res = requests.get('https://api.zephbox.com/api/developers/aliases/x7k2p9/otp/', headers=headers)
print(res.json()['code'])

Resposta

{
  "message_id": 91823,
  "subject": "Your verification code",
  "sender": "[email protected]",
  "received_at": "2026-08-29T10:15:00Z",
  "code": "482913",
  "link": null
}

Esperando um código que ainda não chegou?

Use GET /api/developers/aliases/{alias}/wait-for-otp/ em vez disso — ele bloqueia no servidor (limitado a até 20 segundos) até uma nova mensagem chegar, em vez de você consultar em loop. Veja nosso guia de webhooks vs. polling para saber quando usar cada opção.

A referência completa de endpoints (webhooks, gerenciamento de chaves de API, listagem de mensagens) fica disponível assim que você tem Premium — veja seu painel, ou automatize isso em Python com o SDK do zephbox.