API Pembuatan Stempel
API Pembuatan Stempel memungkinkan Anda menerbitkan stempel kepada pelanggan secara terprogram.
Tentukan Card IDX dan masa berlaku untuk menambahkan stempel ke kartu yang dipilih. Anda juga dapat menyimpan informasi pengguna dan catatan untuk mengelola riwayat stempel setiap pelanggan secara rapi.
Card IDX dapat ditemukan di halaman “Kartu Stempel” pada dashboard.
API ini tersedia mulai dari paket Personal.
/api/stamp/v1/create
{
"cardIdx": 123, // You can check the IDX value on the card management page of the dashboard.
"domain": "https://vvd.bz",
"strtYmd": "2025-01-01",
"endYmd": "2025-12-31",
"activeYn": "Y",
"memo": "New Member Registration, IP: 211.111.222.33",
"userId": "att78z",
"userNm": "Brown Smith",
"userPhnno": "+1 123-4567-8900",
"userEml": "test@gmail.com",
"userEtc1": "Gold rating",
"userEtc2": ""
}
Request Parameters
- cardIdx integer required
-
Card IDX.
Card IDX dapat dilihat di halaman “Kartu Cap” pada dasbor. - domain string
- Default:https://vvd.bz
-
Domain cap.
Jika dikosongkan, akan disimpan menggunakan domain default.
Tersedia untuk paket Premium ke atas — Anda dapat menentukan domain kustom yang terdaftar di bagian Manajemen Domain Tautan. - strtYmd date required
- Tanggal mulai berlaku cap. Contoh: 2025-01-01
- endYmd date required
-
Tanggal berakhir masa berlaku cap. Contoh: 2025-12-31
Tanggal kedaluwarsa dapat diatur hingga maksimal 5 tahun dari hari ini. - activeYn string
- Default:Y
-
Enum:
YN
-
Status aktivasi cap.
Jika dinonaktifkan, pelanggan tidak dapat menggunakan cap tersebut. - memo string
- Catatan internal untuk referensi.
- userId string
-
ID pengguna.
Digunakan untuk mengelola penerima penerbitan cap.
Biasanya diisi dengan ID login anggota situs web.
Jika tidak ditentukan, sistem akan otomatis membuat ID pengguna. - userNm string
- Nama pengguna. Untuk penggunaan internal.
- userPhnno string
- Nomor kontak pengguna. Untuk penggunaan internal.
- userEml string
- Alamat email pengguna. Untuk penggunaan internal.
- userEtc1 string
- Bidang tambahan untuk manajemen internal.
- userEtc2 string
- Bidang tambahan untuk manajemen internal.
{
"code": 0,
"message": "",
"result": 1347
}
Response Parameters
- code integer
- Kode respons: 0 = Berhasil, nilai lainnya = Error
- message string
- Pesan respons. Jika kode bukan 0, pesan error akan dikembalikan.
- result integer
-
Nilai respons.
Stamp IDX yang dihasilkan akan dikembalikan.
Contoh: 1347
Kapan menggunakan API ini
Gunakan API ini untuk membangun kampanye berbasis stempel dan sistem reward.
- Kampanye reward berdasarkan jumlah kunjungan
- Program pengumpulan stempel di toko offline
- Sistem verifikasi aktivitas pengguna
- Pencatatan tindakan tertentu (pembelian, partisipasi, dll.)
Cocok untuk melacak aktivitas pengguna dan mengubahnya menjadi reward.
Hubungan antara kartu stempel dan stempel
Kartu stempel menentukan aturan dan desain kampanye, sedangkan stempel adalah unit yang diberikan kepada pengguna.
Saat memanggil API pembuatan, gunakan cardIdx untuk menentukan kartu tujuan penerbitan stempel.
Card IDX dapat ditemukan di dashboard. Setiap kartu memiliki kondisi dan reward yang berbeda, sehingga penting untuk memilih kartu yang tepat.
Struktur dan komponen pembuatan stempel
Stempel bukan sekadar data, melainkan unit yang merepresentasikan aktivitas pengguna.
Komponen utama:
- Identitas kartu (
cardIdx) : ID kartu tempat stempel terkait - Periode berlaku (
strtYmd,endYmd) : Rentang waktu stempel aktif - Status (
activeYn) : Menunjukkan apakah stempel aktif dan dapat digunakan - Informasi pengguna (
userId,userNm,userEmail, dll.) : Pengguna target - Data tambahan (
memo,userEtc1,userEtc2) : Data kustom
Memungkinkan pelacakan dan pengelolaan aktivitas pengguna secara personal.
Integrasi data pengguna
Field userId digunakan untuk mengidentifikasi dan mengelola penerima stempel.
Biasanya menggunakan ID pengguna dari sistem internal. Jika tidak diisi, sistem akan membuatnya secara otomatis.
Dengan menambahkan userNm, userPhnno, dan userEml, Anda dapat menyimpan informasi kontak dan memantau aktivitas stempel per pengguna melalui dashboard.
Contoh penggunaan
- Stempel selamat datang saat registrasi: Secara otomatis menerbitkan stempel saat pengguna menyelesaikan pendaftaran melalui API
- Reward pembelian otomatis: Memanggil API setelah pembayaran untuk memberikan stempel berdasarkan jumlah pembelian
- Kampanye terbatas waktu: Menerbitkan stempel yang hanya berlaku dalam periode tertentu menggunakan
strtYmd·endYmd - Pencatatan partisipasi event: Memberikan stempel saat pengguna mengikuti event untuk mencatat riwayat
- Manajemen kampanye reward: Memberikan kupon atau benefit berdasarkan jumlah stempel yang terkumpul
Perbedaan dengan API Kupon
API Kupon dan API Stempel sama-sama digunakan dalam marketing, tetapi memiliki tujuan dan cara kerja yang berbeda.
API Kupon berfokus pada konversi dengan mendorong pembelian langsung melalui diskon.
API Stempel berfokus pada retensi dengan mencatat aktivitas pengguna dan mendorong keterlibatan berulang.
1. Tujuan
- API Kupon → Diskon → Mendorong pembelian (Conversion)
- API Stempel → Pencatatan aktivitas → Mendorong kunjungan ulang (Retention)
Kupon efektif untuk peningkatan penjualan jangka pendek, sedangkan stempel cocok untuk retensi jangka panjang.
2. Waktu penggunaan
- Kupon → Sebelum atau saat pembayaran
- Stempel → Saat terjadi aktivitas (kunjungan, partisipasi, dll.)
Kupon mendorong pembelian saat ini, sedangkan stempel mendorong tindakan berikutnya.
3. Struktur data
Kupon bersifat event tunggal.
- Sekali pakai atau terbatas
- Berbasis diskon
- Langsung habis atau berubah status saat digunakan
Stempel bersifat akumulatif.
- Dapat diterbitkan berulang kali
- Dikelola per pengguna
- Reward diberikan saat syarat terpenuhi
Singkatnya, kupon adalah trigger sekali pakai dan stempel adalah data akumulatif.
4. Strategi marketing
Strategi berbasis kupon:
- Akuisisi pengguna baru
- Meningkatkan konversi
Strategi berbasis stempel:
- Mendorong kunjungan ulang
- Meningkatkan loyalitas pelanggan
- Kampanye jangka panjang
5. Penggunaan bersama
Dalam praktiknya, kedua API sering digunakan bersama.
Contoh:
- Mengumpulkan stempel (misalnya 10 kunjungan)
- Menerbitkan kupon otomatis setelah syarat terpenuhi
- Mendorong pembelian melalui penggunaan kupon
Alur ini menghubungkan Engagement → Retention → Conversion dalam satu siklus.
Hal yang perlu diperhatikan
cardIdxharus menggunakan ID kartu yang valid- Tentukan kebijakan yang jelas untuk mencegah duplikasi stempel per pengguna
- Kesalahan pengaturan periode dapat memengaruhi performa kampanye