Dokumentasi

Mulai dengan aman di Postline

Verifikasi domain, akses API, pengiriman sandbox, suppression, dan event pengiriman.

Buka referensi API

Daftar periksa production

  • Verifikasi kepemilikan domain From.
  • Publikasikan rekaman DKIM yang diberikan dan izinkan infrastruktur return-path melalui SPF.
  • Konfigurasikan alignment DMARC dan tinjau hasilnya sebelum pengiriman production diaktifkan.
  • Kunci production tersedia langsung; sebelum verifikasi domain, gunakan sandbox@srs-postline.com hanya untuk anggota proyek.
  • Proses webhook bounce dan complaint secara idempoten dan patuhi keputusan suppression.
POST /v1/emails

Permintaan / Respons

PermintaancURL
curl --request POST 'https://api.srs-postline.com/v1/emails' \
  --header 'Authorization: Bearer srs_live_...' \
  --header 'Idempotency-Key: order_4821' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "from": "Postline <info@example.com>",
    "to": ["user@example.net"],
    "subject": "Your order is ready",
    "html": "<p>Order #4821 is ready.</p>",
    "text": "Order #4821 is ready."
  }'
Respons202 Accepted
HTTP/1.1 202 Accepted
Content-Type: application/json

{
  "id": "msg_01JPOSTLINEEXAMPLE",
  "status": "queued",
  "created_at": "2026-08-22T12:00:00Z"
}

Parameter input

ParameterTipeWajibDeskripsiContoh
Authorizationheader · stringYaKunci API scoped yang diterbitkan dasbor sebagai token Bearer.Bearer srs_live_…
Idempotency-Keyheader · stringTidakPengenal stabil untuk satu pengiriman logis; sangat disarankan.order_4821
fromstringYaNama dan alamat pengirim pada domain terverifikasi.Postline <info@example.com>
tostring[]YaSatu hingga 100 alamat email penerima.["user@example.net"]
subjectstringYaSubjek pesan.Pesanan Anda siap
htmlstringTidakIsi HTML. Salah satu dari html atau text wajib diisi.<p>…</p>
textstringTidakIsi teks biasa. Salah satu dari text atau html wajib diisi.Pesanan #4821…

Kode respons

StatusHTTPDeskripsi
202AcceptedPesan masuk antrean; ini belum berarti pesan terkirim ke kotak masuk.
400Bad RequestJSON tidak valid atau bidang tidak didukung.
401UnauthorizedKunci API tidak valid, kedaluwarsa, atau dicabut.
403ForbiddenScope tidak ada atau domain pengirim belum diverifikasi.
422Unprocessable EntityPenerima berada dalam daftar suppression.
429Too Many RequestsBatas permintaan proyek terlampaui.
Contoh kesalahan422 Unprocessable Entity
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
  "error": "recipient suppressed"
}

Istilah autentikasi

Postline menandatangani pesan dengan DKIM. SPF adalah kebijakan otorisasi yang dipublikasikan di DNS. DMARC mengevaluasi alignment antara domain From yang terlihat dan identitas SPF atau DKIM yang terautentikasi; SPF dan DMARC bukan tanda tangan pesan.

TLS melindungi data dalam perjalanan antar hop yang mendukungnya. Email biasa tidak dienkripsi end-to-end, dan penyedia penerima dapat memproses konten pesan.

Hasil pengiriman

Diterimanya pesan oleh server penerima tidak membuktikan penempatan di inbox. Perlakukan accepted, deferred, hard bounce, soft bounce, complaint, suppressed, spam placement, dan inbox placement sebagai hasil yang berbeda-beda.

Model akses saat ini

Kunci saat ini memakai srs_live_. Sebelum domain From diverifikasi, pengirim sandbox bersama hanya dapat mengirim ke anggota proyek. Setelah itu kuota, suppression, batas penerima, dan kontrol abuse tetap berlaku. 202 berarti masuk antrean, bukan terkirim.

Sumber daya integrasi

Gunakan panduan langkah demi langkah untuk manusia dan agen AI; OpenAPI adalah sumber kebenaran field.