Kami menghadirkan fitur pengiriman email melalui API sebagai opsi tambahan pengiriman email selain melalui SMTP. Pengiriman email via API ini sangat cocok untuk developer, agar dapat melakukan konfigurasi email pada aplikasinya melalui API dan mengirimkan email dengan layanan Aktiva Transaksional Email.
Pengiriman email melalui API akan memberikan response yang realtime, apabila terdapat kendala atau kesalahan pada konfigurasi email yang dapat memudahkan developer.
Autentikasi #
Autentikasi untuk customer mengirimkan email via API yakni menggunakan Bearer Token berupa API Token atau API Key, yang bisa didapatkan pada dashboard Aktiva Transaksional Email. Untuk mendapatkan API Token tersebut user dapat login ke dashboard dan mengakses menu Email API dan copy API Token yang sudah tersedia.
Apabila API Token belum tersedia, silakan generate terlebih dahulu dengan mengikuti panduan pada dokumentasi: Memulai Pengiriman Email melalui API. Pastikan status API dan status berlangganan anda aktif, untuk dapat menggunakan dan mengirimkan email melalui API tersebut.
Pengiriman Email via API #
Url:
https://api-transaksional.aktiva.co.id/app/v1/send
Method:
POST
| Field | Type | Details |
|---|---|---|
| from | string | alamat email pengirim* |
| to | string/array of string | alamat email tujuan atau penerima* |
| cc | string/array of string | alamat email tembusan |
| bcc | string/array of string | alamat email bcc |
| replyTo | string | alamat email yang akan menerima balasan |
| subject | string | subjek email* |
| content | string | isi dari konten email* |
| content_type | string | tipe konten email: html/text* |
| attachments | array of object | lampiran email berupa file |
* wajib diisi dan tidak boleh dikosongkan
Response API #
| Status | Message | Deskripsi |
|---|---|---|
| success | Message queued as $queueId” | Email berhasil dikirimkan ke server |
| failed | No token provided! | API Token belum dikonfigurasi |
| failed | Not authorized! | API Token tidak valid |
| failed | Send access denied! | Domain yang digunakan tidak terdaftar/inactive |
| failed | \”from\” must be a valid email | Alamat email pengirim tidak valid |
| failed | \”to[0]\” must be a valid email | Alamat email penerima tidak valid |
| failed | \”replyTo\” must be a valid email | Alamat email reply to tidak valid |
| failed | \”subject\” must be a string | Format subject tidak sesuai |
| failed | \”content_type\” must be one of [html, text] | Tipe konten tidak sesuai |
| failed | \”\” is not allowed | Tipe file tidak disupport |
| failed | Cannot upload file to \”\” field | Terdapat kesalahan saat upload file |
| failed | Internal server error | Terdapat kendala pada server Aktiva |
| failed | Your API sending token status is curently locked | Email API dalam kondisi locked, tidak dapat mengirim email |
| failed | Your API sending token status is curently suspended | Email API dalam kondisi suspend, tidak dapat mengirim email |
