REST API

Pelajari cara mengintegrasikan dan menggunakan EngageLab SMS REST API.

Layanan EngageLab SMS menyediakan sekumpulan RESTful API, yang memungkinkan Anda membuat template dan signature, mengirim SMS, serta mengecek saldo secara terprogram.

Ikuti langkah-langkah berikut untuk mulai menggunakan REST API.

Membuat API Key

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

Login ke konsol EngageLab.
Masuk ke subkonsol SMS dan pilih aplikasi Anda.
Pada navigasi sisi kiri, navigasikan ke API Keys.
Klik Create API Key untuk membuat dev_key dan dev_secret baru.

⚠️ Peringatan
dev_secret Anda sangat sensitif. Harap simpan dengan aman dan jangan pernah membocorkannya di kode sisi klien atau repositori kode publik.

Autentikasi

EngageLab SMS API menggunakan HTTP Basic authentication. Anda harus menyertakan request header Authorization pada semua request API.

Header ini dibangun menggunakan dev_key dan dev_secret Anda dengan encoding Base64:

Authorization: Basic ${base64_auth_string}

              
              Authorization: Basic ${base64_auth_string}

Tampilkan blok kode ini di jendela mengambang

${base64_auth_string} dihasilkan dengan menggabungkan dev_key dan dev_secret Anda melalui tanda titik dua (:) lalu melakukan encoding Base64: base64(dev_key:dev_secret).

Untuk detail lebih lanjut, silakan 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://smsapi.engagelab.com.

Berikut adalah beberapa API utama yang dapat Anda integrasikan:

Mengirim SMS: Mengirim SMS ke satu atau beberapa nomor ponsel tujuan, mendukung pengiriman notifikasi dan SMS pemasaran secara otomatis.
Cek Saldo: Mengecek saldo yang tersedia pada akun EngageLab SMS secara real-time melalui API, termasuk informasi saldo reguler dan saldo bonus.
Pengelolaan Template: Membuat, mengubah, menghapus, mendapatkan daftar semua template, serta melihat detail template secara terprogram.
Pengelolaan Signature: Membuat, mengubah, menghapus, mendapatkan daftar semua signature, serta melihat detail signature secara terprogram.
Referensi Event Callback: Mengonfigurasi alamat callback dan menggunakan mekanisme verifikasi keamanan untuk menerima status report dan notifikasi.
SMPP: Menggunakan protokol SMPP untuk mewujudkan pengiriman pesan dan pelaporan status yang efisien dan andal melalui koneksi TCP.