REST API v1

Dokumentasi API REST Developer

Buat kotak masuk sekali pakai secara terprogram dan ekstrak kode OTP atau magic link. Membutuhkan paket Premium aktif — lihat Harga.

1. Autentikasi

Autentikasi setiap permintaan dengan kunci API rahasia Anda di header X-API-Key. Buat kunci dari dasbor Anda.

X-API-Key: khml_live_9f87a6b5c4d3e2f10987
Contoh kode:
POST/api/developers/aliases/

Membuat kotak masuk sekali pakai baru untuk akun Anda.

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

Respons

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

Mengekstrak kode verifikasi atau magic link dari pesan terbaru alias. Mengembalikan pesan terbaru dengan code/link bernilai null jika tidak ada yang cocok — tidak pernah 404 biasa setelah email tiba.

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

Respons

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

Menunggu kode yang belum tiba?

Gunakan GET /api/developers/aliases/{alias}/wait-for-otp/ sebagai gantinya — ini menahan (blocking) di sisi server (dibatasi, hingga 20 detik) sampai pesan baru tiba, alih-alih Anda melakukan polling berulang. Lihat panduan webhook vs. polling kami untuk tahu kapan memakai masing-masing opsi.

Referensi endpoint lengkap (webhook, manajemen kunci API, daftar pesan) tersedia begitu Anda berlangganan Premium — lihat dasbor Anda, atau otomatiskan ini di Python dengan SDK zephbox.