API referansı

E-posta gönder

Send transactional mail only from your verified custom domains over HTTPS — password resets, receipts, alerts, and similar event-driven messages. Not for newsletters or marketing bulk. One endpoint, domain-scoped API keys, delivery through AWS SES.

Genel Bakış

Bitiş Noktasıhttps://api.unbox.im/v1/email
YöntemPOST
İçerik Türüapplication/json
KapsamBir özel alan adı için bir API anahtarı

DNS doğrulaması tamamlandıktan sonra Hesap → Alan Adları → alan adınız → API kısmından anahtarlar oluşturun. Tam sırrı bir kez gösterir - güvenli bir yerde saklayın. Aynı Alan Adları panelindeki isteğe bağlı SMTP kimlik bilgileri de aynı işlemli sadece kuralına uygundur.

Sadece işlemli e-posta

Unbox HTTP API (POST /v1/email) and optional SMTP submission are for transactional mail only — messages tied to an account action, purchase, or operational event. They are not a newsletter or marketing broadcast service.

Yetkili Kullanımlar

  • Hesap doğrulama, şifre sıfırlama ve güvenlik bildirimleri
  • Sipariş onayları, fişler, teslimat güncellemeleri ve ödeme bildirimleri
  • Belirli bir kullanıcı veya sistem olayı tarafından tetiklenen bildirimler
  • Ekip ve çalışma alanı mesajları (davetler, atamalar, iç bildirimler)

Yasaklı Kullanımlar

  • Bültenler, tanıtım kampanyaları veya yayın pazarlama
  • Soğuk outreach veya satın alınmış, taranmış veya izin verilmemiş listelere e-posta gönderme
  • Ortak spam, phishing veya kandırıcı içerik
  • Herhangi bir girişim, alıcı kapasitelerini, hız sınırlarını veya plan kotasını kaçarmak

Hız ve alıcı sınırlamaları

Alıcıları ve teslimatı korumak için, outbound API ve SMTP trafiği aşağıdaki sınırlara tabidir (aylık outbound kotası dahil). Uygulama web editörü, HTTP API ve SMTP gönderimi üzerinden etkin. Web editörü, mesaj başına 25 alıcıdan sonra uyarı verir ve 50'den fazla alıcıya gönderim engeller.

SınırlamaDeğer
Mesaj başına alıcılarToplam 50'ye kadar (To + Cc + Bcc birleştirildiğinde)
Günlük benzersiz alıcılarHer çalışma alanı için 1.000'ye kadar
Gönderim isteği hızıHer domain için dakikada 10 API veya SMTP gönderimiye kadar
Plan dışarıya gönderim kotasıAboneliklerinizdeki aylık gönderim sınırları hâlâ geçerli

Bu kurallar, Kullanım Kurallarımızın bir parçasıdır. Otomatik uygulama web düzenleyicisi, HTTP API ve SMTP gönderimleri üzerinde etkili. Pazarlama veya büyük veri gönderimi yaparak veya gönderim altyapısını abus eden hesaplar, sınırlı hale getirilebilir, askıya alınabilir veya sonlandırılabilir.

Gönderim başarı sinyallerini izliyoruz. Sürekli geri dönüş oranları %3'ten yüksekse veya şikayet oranları %0.1'den yüksekse, geçici gönderim durdurma veya el ile inceleme tetiklenebilir.

Tam politika detayları için İş Koşulları, Veri Politikası ve GDPR Bildirimi sayfalarımızı inceleyin.

Yetkilendirme

Her istekte alan adı API anahtarınızı gönderin:

Authorization: Bearer ubk_live_xxxxxxxxxxxxxxxxxxxxxxxx

Alternatif olarak, X-Api-Key: ubk_live_… kullanın. Anahtarlar şifrelenerek depolanır; Domains panelden iptal edilebilir veya döndürülebilir.

İstek gövdesi

PascalCase alan adlarıyla JSON (From, To, …). camelCase alternatifleri de kabul edilir.

AlanZorunluAçıklama
FromEvetGönderici — ana veya alias olarak ana e-posta adresiniz (ana e-posta veya alias). Paylaşılan kuyruklar geçerli göndericiler değildir.
ToEvetAlıcılar — string, virgülle ayrılmış string veya dizi
SubjectEvetKonu satırı
TextBodyBirinden TextBody / HtmlBodyYazdırılabilir metin içeriği
HtmlBodyBirinden TextBody / HtmlBodyHTML içeriği
CcHayırKopya alıcılar
BccHayırKör kopya alıcılar
ReplyToHayırCevap vermek için adres
TagHayırİsteğe bağlı meta veri etiketi (gönderimle birlikte saklanır)

Örnek

{
  "From": "you@yourdomain.com",
  "To": "user@example.com",
  "Subject": "Welcome",
  "TextBody": "Thanks for signing up.",
  "HtmlBody": "<p>Thanks for signing up.</p>",
  "ReplyTo": "you@yourdomain.com",
  "Tag": "welcome"
}

Başarılı yanıt

HTTP 200 ile JSON:

{
  "ErrorCode": 0,
  "Message": "OK",
  "MessageID": "0100018…-000000-…",
  "SubmittedAt": "2026-06-23T12:00:00.000Z",
  "To": "user@example.com"
}

Hata yanıtları

Hatalar 4xx döner (veya 500 beklenmeyen başarısızlıklar için) JSON ile:

{
  "ErrorCode": 300,
  "Message": "TextBody or HtmlBody is required."
}
HataKoduAnlamı
0Başarılı
10API anahtarı eksik
11Geçersiz veya iptal edilen anahtar, veya gönderim için doğrulanmamış alan adı
300Doğrulama hatası (eksik alanlar, geçersiz JSON, vb.)
403Gönderen adresi izin verilmiyor — anahtarın alan adında kişisel posta kutunuz olmalıdır
406SES mesajı reddetti

Örnekler

you@yourdomain.com yerine alan adınızda kişisel posta kutunuzu ve kendi API anahtarınızı kullanın.

curl "https://api.unbox.im/v1/email" \
  -H "Authorization: Bearer ubk_live_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "From": "you@yourdomain.com",
  "To": "user@example.com",
  "Subject": "Welcome",
  "TextBody": "Thanks for signing up.",
  "HtmlBody": "<p>Thanks for signing up.</p>",
  "ReplyTo": "you@yourdomain.com",
  "Tag": "welcome"
}'

Başlangıç

  1. Unbox hesabınızı oluşturun ve özel alanınızı ekleyin.
  2. Domains'de tüm DNS doğrulama adımlarını tamamlayın.
  3. Domains → alanınız → API'ye gidin ve bir alan anahteri oluşturun.
  4. Yukarıdaki örneklerle ilk mesajınızı gönderin.
Unbox — API Belgeleri | Unbox.im