REST API Overview

Dasar

• API dirancang agar sesuai dengan spesifikasi HTTP dan REST. Misalnya, metode GET digunakan untuk permintaan query dan metode POST digunakan untuk permintaan pengiriman. Jika permintaan tidak menggunakan metode HTTP yang sesuai, maka akan dikembalikan error.
• Kecuali ada keterangan khusus, nilai parameter panggilan harus di-transcode ke UTF-8 dan URL Encoding.

Pusat Data dan Base URL

Mulai 19 Maret 2025, pengembang yang baru mengakses Engagelab Push API diminta untuk menggunakan nama domain berikut. Base URL lama dengan akhiran .cc masih dapat digunakan, namun pengembang disarankan untuk beralih ke nama domain terbaru.

Saat menggunakan REST API, Anda perlu menggabungkan base URL yang dipilih dengan path API spesifik untuk mendapatkan endpoint lengkap.

              
              {base URL}/{API path}

            

Di sini, {base URL} adalah base URL pusat data yang dipilih, dan {API path} adalah path endpoint API spesifik, misalnya v4/devices/{registration_id}.

Contoh:

• Misalkan pusat data Singapura dipilih dengan base URL https://webpushapi-sgp.engagelab.com.
• Jika tujuannya adalah menghapus informasi registrasi untuk perangkat tertentu, dan path API-nya adalah v4/devices/{registration_id}, maka endpoint API lengkapnya menjadi:

              
              https://webpushapi-sgp.engagelab.com/v4/devices/{registration_id}

            

Di sini, {registration_id} adalah ID registrasi perangkat yang dimaksud.

Dengan cara ini, Anda dapat membangun URL endpoint API lengkap untuk mengakses berbagai pusat data.

Metode Autentikasi

Engagelab REST API menggunakan HTTP basic authentication
Metode dasarnya adalah menambahkan Authorization pada HTTP Header:

              
              Authorization: Basic base64_auth_string

            

Algoritma pembuatan base64_auth_string adalah base64(appKey:masterSecret)
Artinya, tambahkan tanda titik dua setelah appKey, lalu gabungkan dengan masterSecret, kemudian lakukan konversi base64.
Silakan buka halaman pengaturan aplikasi - informasi aplikasi untuk mendapatkan parameter appKey dan masterSecret.

Contoh Autentikasi

Jika appKey Anda adalah "c96f42e0d2e662e45d035ab1", dan masterSecret Anda adalah "df4d59e84eac2f9d53b36f12", saat memanggil Push API v4, gunakan perintah curl berikut:

              
              curl --insecure -X POST -v https://webpushapi-sgp.engagelab.com/v4/push 
-H "Content-Type: application/json" 
-u "c96f42e0d2e662e45d035ab1:df4d59e84eac2f9d53b36f12" 
-d '{"from":"push","to":"all","body":{"platform":"web","notification":{"alert":"Hi,MTPush !","web":{"alert":"Hi,MTPush !", "title":"web_push", "url":"http://www.google.com","extras":{"web-key1":"web-value1"}}}},"request_id":"12345678", "custom_args":"business info"}'

            

Permintaan HTTP-nya adalah:

              
              > POST /v4/push HTTP/1.1
> Authorization: Basic Yzk2ZjQyZTBkMmU2NjJlNDVkMDM1YWIxOmRmNGQ1OWU4NGVhYzJmOWQ1M2IzNmYxMg==