REST API

Pelajari cara mengintegrasikan dan menggunakan EngageLab OTP REST API.

Layanan EngageLab OTP menyediakan sekumpulan RESTful API, yang memungkinkan Anda membuat template, mengirim OTP, dan memverifikasi kode verifikasi secara terprogram.

Ikuti langkah-langkah berikut untuk mulai menggunakan REST API.

Membuat API Key

Sebelum memanggil EngageLab OTP API apa pun, Anda perlu membuat API Key untuk mengautentikasi request Anda.

Login ke konsol EngageLab.
Masuk ke subkonsol OTP dan pilih aplikasi Anda.
Navigasikan ke API Keys pada bilah navigasi kiri.
Klik Create API Key untuk membuat dev_key dan dev_secret baru.

⚠️ Peringatan
dev_secret Anda sangat sensitif. Pastikan untuk menyimpannya dengan baik, dan jangan pernah membocorkannya dalam kode sisi klien atau repositori kode publik.

Autentikasi

EngageLab OTP API menggunakan HTTP Basic Auth. Anda harus menyertakan header Authorization dalam semua request API.

Header ini dibangun menggunakan dev_key dan dev_secret Anda yang di-encode dengan Base64:

Authorization: Basic ${base64_auth_string}

              
              Authorization: Basic ${base64_auth_string}

Tampilkan blok kode ini di jendela mengambang

${base64_auth_string} dibuat dengan menggabungkan dev_key dan dev_secret Anda menggunakan tanda titik dua (:), lalu meng-encode-nya dengan Base64: base64(dev_key:dev_secret).

Untuk detail lebih lanjut, lihat panduan Autentikasi.

Memanggil API

Setelah mendapatkan API Key dan memahami mekanisme autentikasi, Anda dapat mulai memanggil API. Semua endpoint API menggunakan base URL https://otp.api.engagelab.cc.

Berikut adalah beberapa API utama yang dapat Anda integrasikan:

Pengiriman OTP: membuat kode verifikasi melalui platform EngageLab, dan mengirimkannya sesuai strategi template Anda.
Verifikasi OTP: memverifikasi secara aman one-time password (kode verifikasi) yang dikirimkan pengguna.
Pengiriman OTP Kustom: jika Anda ingin membuat kode verifikasi sendiri, Anda dapat mengirimkan kode verifikasi yang telah dibuat sebelumnya kepada pengguna.
Pengiriman Pesan Kustom: mengirim konten pesan yang dibuat berdasarkan template kustom (misalnya notifikasi atau pesan marketing).
Manajemen Template: membuat, menghapus, mendapatkan daftar semua template, serta melihat detail template secara terprogram.
Konfigurasi Callback: mengonfigurasi alamat callback dan menggunakan mekanisme validasi keamanan untuk menerima laporan status dan notifikasi.
Callback Status Siklus Hidup: menerima data status pesan secara real-time melalui callback di setiap tahap siklus hidup seperti pengiriman, penerimaan, dan verifikasi.
SMPP: menggunakan protokol SMPP untuk mewujudkan pengiriman pesan dan pelaporan status yang efisien dan andal melalui koneksi TCP.