REST API v1

Documentación de la API REST para Desarrolladores

Crea buzones desechables programáticamente y extrae códigos OTP o enlaces mágicos. Requiere un plan Premium activo — consulta Precios.

1. Autenticación

Autentica cada solicitud con tu clave de API secreta en el encabezado X-API-Key. Genera una clave desde tu panel.

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

Crea un nuevo buzón desechable para tu cuenta.

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'])

Respuesta

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

Extrae un código de verificación o enlace mágico del mensaje más reciente del alias. Devuelve el mensaje más reciente con code/link como null si nada coincide — nunca un simple 404 una vez que ha llegado correo.

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'])

Respuesta

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

¿Esperando un código que aún no ha llegado?

Usa GET /api/developers/aliases/{alias}/wait-for-otp/ en su lugar — bloquea del lado del servidor (limitado a 20 segundos) hasta que llegue un mensaje nuevo, en vez de que tú consultes en un bucle. Consulta nuestra guía de webhooks vs. polling para saber cuándo usar cada opción.

La referencia completa de endpoints (webhooks, gestión de claves de API, listado de mensajes) está disponible en cuanto tengas Premium — consulta tu panel, o automatízalo en Python con el SDK de zephbox.