Aktiva Transaksional Email menyediakan fitur pengiriman email melalui API, sebagai opsi tambahan untuk pengiriman email selain melalui SMTP. Pengiriman melalui API dapat lebih memudahkan developer dalam melakukan konfigurasi pengiriman emailnya melalui aplikasi atau program yang dimiliki perusahaan.
Persiapan #
Untuk dapat melakukan pengiriman email tersebut, pastikan anda sudah memenuhi persyaratan berikut
- Memiliki akun Aktiva Transaksional Email yang terdaftar (https://apps.aktiva.co.id)
- Memiliki paket layanan atau subscription yang aktif
Generate API Key #
Apabila anda sudah memenuhi persyaratan diatas, anda dapat menikmati fitur pengirman email melalui API. Namun sebelum dapat menggunakannya, anda harus terlebih dahulu memiliki API Key atau API Token yang berfungsi sebagai autentikasi untuk pengiriman email tersebut. Anda dapat melakukan generate API Key dengan mengikuti panduan berikut
- Login ke Dashboard Aktiva Transaksional email anda
- Akses halaman Email API dengan klik menu Email API
- Pada card API Details, klik tombol Generate API Key untuk membuat API Key anda
- Klik Generate API Key dan tunggu proses pembuatan API Key hingga selesai
- Gunakan API Key atau API Token sebagai autentikasi pengiriman email anda melalui API
Re-generate API Key #
Customer yang sudah melakukan generate dan memiliki API Key sebelumnya, dapat melakukan generate ulang untuk mendapatkan API key atau API token terbaru. Proses re-generate API key tersebut secara otomatis akan menonaktifkan API key atau API token sebelumnya, sehingga menjadi tidak valid.
Proses re-generate API Key tersebut dapat dilakukan apabila API Key tersebut disalahgunakan atau tersebar luas dan membahayakan.
Note: pastikan anda melakukan konfigurasi ulang dan menyesuaikan konfigurasi API key atau API token setelah melakukan proses re-generate
Untuk melakukan re-generate API key tersebut, anda dapat mengikuti langkah atau panduan berikut:
- Login ke Dashboard Aktiva Transaksional email anda
- Akses halaman Email API dengan klik menu Email API
- Pada card API Details, klik tombol Re-generate API Key untuk membuat ulang API Key anda
- Konfirmasi dengan klik tombol Re-generate API Key, dan tunggu proses pembuatan ulang API Key hingga selesai
- Sesuaikan konfigurasi API Key atau API Token pada aplikasi atau program anda
Revoke API Key #
API Key yang sudah di generate tidak dapat direvoke atau dihapus dari sistem. Namun jika anda ingin melakukan revoke API Key yang sudah dikonfigurasi pada salah satu aplikasi atau program, anda dapat melakukan re-generate seperti pada panduan sebelumnya. Sehingga aplikasi atau program yang sudah dikonfigurasi tersebut tidak dapat mengirimkan email kembali menggunakan API key atau API token anda.