API sənədləşdirməsi

Hər poçt qutusuna aid API açarı ilə proqramlı şəkildə məktub göndərin. API girişi olan planlarda mövcuddur — hansılarda olduğunu Qiymətlər səhifəsində görün.

Autentifikasiya

Hər sorğu Bearer token daşıyan Authorization başlığı tələb edir. Vebmail Ayarlar → API Açarları bölməsindən yaradın — xam token yalnız yaradıldığı anda bir dəfə göstərilir.

Yalnız API girişi olan planda olan poçt qutuları açar yarada və ya bu endpoint vasitəsilə göndərə bilər. Planı bunu əhatə etməyən bir poçt qutusundan göndərmək 403 qaytarır.

Mesaj göndərmək

POST https://api.unet.az/api/v1/send

curl -X POST https://api.unet.az/api/v1/send \
  -H "Authorization: Bearer umk_live_xxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "to": ["[email protected]"],
    "subject": "Hello from the API",
    "body_text": "Sent with POST /api/v1/send"
  }'

Sorğu sahələri

Sahə	Tip	Təsvir
to	string[] (tələb olunur)	Bir və ya bir neçə alıcı e-poçt ünvanı.
cc	string[]	Əlavə CC alıcıları (istəyə bağlı).
bcc	string[]	Əlavə BCC alıcıları (istəyə bağlı).
subject	string	Mesajın mövzu sətri.
body_text	string	Sadə mətn məzmunu.
body_html	string	HTML məzmunu. body_text, body_html və ya hər ikisini göndərin.

Cavab

Uğurlu göndərmə 201 kodu ilə yaradılmış mesajı qaytarır, o cümlədən id (öz qeydləriniz üçün faydalıdır) və "pending" olaraq başlayan delivery_status — çatdırılma özü asinxron baş verir.

HTTP/1.1 201 Created

{
  "id": 149,
  "subject": "Hello from the API",
  "direction": "outbound",
  "delivery_status": "pending",
  "sent_at": "2026-08-01T08:06:06.000000Z",
  "recipients": [
    { "type": "to", "address": "[email protected]" }
  ]
}

Sürət limitləri

Hər planın saatlıq və/və ya aylıq göndərmə limiti var. Bunlar eyni poçt qutusundakı hər göndərmə kanalı arasında paylaşılır — vebmail, API və SMTP göndərilməsi ayrı hovuzlar deyil, eyni hovuzdan istifadə edir. Hər hansı limiti keçmək 429 və maşın tərəfindən oxuna bilən xəta kodu ilə cavab qaytarır:

HTTP/1.1 429 Too Many Requests

{
  "error": "hour_limit_exceeded",
  "message": "You've reached your Pro plan's limit of 100 sent messages per hour."
}

Xəta cavabları

401	Bearer token yoxdur və ya yanlışdır.
403	Poçt qutusunun planı API girişini əhatə etmir.
422	Doğrulama uğursuz oldu, və ya mesaj poçt qutusunun yaddaş kvotasını aşacaq.
429	hour_limit_exceeded və ya month_limit_exceeded — planın həmin pəncərə üçün göndərmə sürəti limitini aşıb.