Panduan Integrasi Web SDK

Dokumen ini merupakan panduan integrasi standar untuk MA Web SDK.

Persiapan Sebelum Integrasi

Untuk menggunakan layanan EngageLab MA, Anda harus mengintegrasikan modul WebPush terlebih dahulu.
Siapkan nama domain layanan web HTTPS yang dapat diakses. Setelah integrasi, semua halaman harus diuji dan debug di bawah nama domain ini. Push web offline tidak mendukung debug lokal maupun HTTP.
Masuk ke Engagelab WebPush, lalu pada halaman [Pengaturan Integrasi] - [Nama Domain Website], isi nama domain layanan web HTTPS Anda.

Tangkapan layar 2022-11-29 11.08.16.png

Deskripsi Produk

Modul MA pada EngageLab Web SDK menyediakan fungsi pengumpulan dan pelaporan data, digunakan untuk skenario seperti pembuatan EUID, pengaturan properti pengguna, dan pelaporan event.

Skenario Utama:

Mengatur berbagai jenis properti dan melaporkan berbagai jenis event.

Mendapatkan Informasi Aplikasi

Anda perlu membuat aplikasi pada konsol WebPush. Setelah berhasil dibuat, AppKey akan otomatis dihasilkan sebagai identitas aplikasi. Untuk detailnya, silakan lihat Dokumen Pengaturan Aplikasi.

Akses SDK

Masuk ke Konsol, unduh SDK, dan sertakan JavaScript berikut di setiap halaman:

              
              <script type="text/javascript" src="./webPushSdk.min.3.0.0.js"></script>

Tampilkan blok kode ini di jendela mengambang

Tips

Setelah mengimpor JavaScript ini, aktifkan properti maOpen dengan nilai true untuk mengaktifkan konfigurasi MA, sehingga Anda dapat menggunakan API dan fungsi terkait MA.

Inisialisasi SDK

// Inisialisasi (Aktifkan MA) MTpushInterface.init({ appkey: "", // Wajib diisi, lihat informasi aplikasi di atas user_str: "adminDemo", // Wajib diisi, penanda pengguna untuk menandai user swUrl: "url", // Default: "/sw.min." + sdkEnv.version + ".js". Konfigurasi ini adalah alamat file server worker. Domain harus domain saat ini, dan path menentukan cakupan server worker. debugMode: true, // Atur apakah akan mengaktifkan mode debug. true akan menampilkan lebih banyak log; false hanya menampilkan log level w dan e. channel: "default-channel", // Nama channel, nilai default: default-channel appName: "string", // Digunakan untuk mengatur nama website saat pelaporan maOpen: true, // Pengaturan untuk mengaktifkan fungsi MA userIdentity: { userId: "1234567890", anonymousId: "anonymous123" }, // Atur identitas pengguna saat inisialisasi MA. Didukung sejak v3.3.4, berlaku untuk perusahaan yang menyediakan layanan MA khusus untuk anggota yang sudah login maCompletion: (code, msg) => { // Callback inisialisasi MA if (code === 0) { console.log("✅MA SDK berhasil diinisialisasi!"); } else { console.error("❌Inisialisasi MA SDK gagal:", msg); } } });

              
              // Inisialisasi (Aktifkan MA)
MTpushInterface.init({
  appkey: "", // Wajib diisi, lihat informasi aplikasi di atas
  user_str: "adminDemo", // Wajib diisi, penanda pengguna untuk menandai user
  swUrl: "url", // Default: "/sw.min." + sdkEnv.version + ".js". Konfigurasi ini adalah alamat file server worker. Domain harus domain saat ini, dan path menentukan cakupan server worker.
  debugMode: true, // Atur apakah akan mengaktifkan mode debug. true akan menampilkan lebih banyak log; false hanya menampilkan log level w dan e.
  channel: "default-channel", // Nama channel, nilai default: default-channel
  appName: "string", // Digunakan untuk mengatur nama website saat pelaporan
  maOpen: true, // Pengaturan untuk mengaktifkan fungsi MA
  userIdentity: { userId: "1234567890", anonymousId: "anonymous123" }, // Atur identitas pengguna saat inisialisasi MA. Didukung sejak v3.3.4, berlaku untuk perusahaan yang menyediakan layanan MA khusus untuk anggota yang sudah login
  maCompletion: (code, msg) => { // Callback inisialisasi MA
    if (code === 0) {
      console.log("✅MA SDK berhasil diinisialisasi!");
    } else {
      console.error("❌Inisialisasi MA SDK gagal:", msg);
    }
  }
});

Tampilkan blok kode ini di jendela mengambang

API Lainnya

Untuk penggunaan API lainnya, silakan lihat dokumentasi antarmuka: Web SDK API.