Aplikasi Anda mengirim data terstruktur ke endpoint HTTP dan menerima respons berisi hasil pengiriman pesan atau kesalahan. Permintaan dan respons tersebut adalah permukaan kerja API email.
Apa yang ditangani API email?
Endpoint pengiriman menerima penerima, subjek, dan konten teks atau HTML. Endpoint ini juga dapat menerima header, tag, template, dan lampiran jika penyedia mendukungnya.
Endpoint event atau webhook melaporkan apa yang terjadi setelah penerimaan. Event umum meliputi pengiriman, bounce, keluhan, open, dan click. API penerimaan mengubah email masuk menjadi pesan terstruktur untuk aplikasi Anda, sehingga Anda tidak perlu melakukan polling ke mailbox.
Apa perbedaan API email dengan SMTP?
SMTP mengharuskan aplikasi Anda membuka koneksi, melakukan autentikasi, mengirim perintah, dan membaca kode balasan. API email menggunakan permintaan HTTP sebagai gantinya, sehingga pustaka klien dapat menangani penggunaan ulang koneksi, encoding JSON, percobaan ulang, dan parsing respons.
Pilih API jika aplikasi Anda sudah menggunakan HTTP, membutuhkan event terstruktur, atau berjalan di lingkungan yang sulit membuka koneksi SMTP. Pilih relay SMTP jika pustaka email atau mail server yang ada sudah mendukung SMTP. Kedua jalur dapat mengirim pesan yang sama.
| Tugas | API pengiriman | Relay SMTP | Mailbox API |
|---|---|---|---|
| Mengirim pesan | Ya | Ya | Balas atau tulis |
| Menerima email terurai | Beberapa penyedia | Tidak | Ya |
| Membaca riwayat percakapan | Beberapa penyedia | Tidak | Ya |
| Memantau pengiriman | Event atau webhook | Kode balasan dan event | Status pesan dan event |
Produk menggunakan istilah API email untuk cakupan kemampuan yang berbeda-beda. Periksa skema penyedia sebelum mengasumsikan satu API mencakup semua baris.
Apa yang harus disertakan dalam permintaan API?
Kirim field yang diperlukan penyedia Anda. Catat identifier pesan yang dikembalikan. Simpan idempotency key Anda sendiri jika percobaan ulang tidak boleh membuat pengiriman duplikat. Validasi penerima sebelum mengirim. Simpan secret di server Anda.
Contoh permintaan transaksional memiliki from, to, subject, text, category: transactional, dan idempotency key yang disimpan di server. Gunakan domain pengirim yang terverifikasi sebelum mengirimnya.
Respons HTTP berarti layanan menerima permintaan tersebut. Event pengiriman, bounce, dan keluhan tiba kemudian, sehingga respons diterima tidak menjamin penempatan di inbox.
Gunakan webhook untuk event selanjutnya, bukan menganggap permintaan yang diterima sebagai bukti bahwa pesan sampai ke inbox. Event pengiriman dan keluhan menjelaskan apa yang terjadi setelah penerimaan.
Bagaimana cara mengirim dengan Bird?
Anda memanggil createEmailMessage API Bird dengan kunci API workspace Anda, pengirim, penerima, konten, dan metadata opsional. Panduan pengiriman email menunjukkan field permintaan dan respons.
Untuk balasan dan email masuk, buat mailbox dan konsumsi event pesan serta pengirimannya. Panduan mailbox membahas endpoint dan nama webhook tersebut.
Ringkasan
- API email menyediakan pengiriman dan event pesan melalui HTTP.
- Respons mengonfirmasi penerimaan API, bukan penempatan di inbox.
- Idempotency key memungkinkan percobaan ulang yang aman.
- Bird menyediakan API pengiriman dan mailbox dengan panduan untuk setiap jalur.