Menanyakan EUID

Gunakan API ini untuk menanyakan EUID pengguna yang sudah ada berdasarkan pengenal pengguna yang dikonfigurasi di proyek. API ini hanya membaca data yang sudah ada. Jika tidak ada kecocokan, API tidak membuat pengguna atau EUID baru. API ini menerapkan batas 1.000 permintaan per menit per proyek; jika terlampaui, HTTP 429 dengan kode error 55110 akan dikembalikan.

Alamat Endpoint

POST /v1/user/euid

Verifikasi Permintaan

REST API EngageLab menggunakan HTTP Basic Authentication:

Authorization: Basic ${base64_auth_string}
              
              Authorization: Basic ${base64_auth_string}

            
Tampilkan blok kode ini di jendela mengambang

Buat base64_auth_string dengan base64(api_key:api_secret).

Contoh Permintaan

{ "identity_name": "user_id", "identity_values": ["user-1", "user-2"] }
              
              {
    "identity_name": "user_id",
    "identity_values": ["user-1", "user-2"]
}

            
Tampilkan blok kode ini di jendela mengambang

Parameter Permintaan

Field Tipe Wajib Deskripsi
identity_name String Ya Nama pengenal pengguna yang dikonfigurasi di proyek.
identity_values Array Ya Nilai pengenal; 1 hingga 100 nilai, masing-masing maksimal 256 karakter.

Parameter Respons

Field Tipe Deskripsi
code Int 0 berarti berhasil, termasuk saat nilai tidak ditemukan.
message String Deskripsi hasil.
data Array Hasil dalam urutan yang sama dengan permintaan.
identity_value String Nilai pengenal yang diminta.
euid Long EUID yang ada atau null jika pengguna tidak ditemukan.
error_code Int 0 untuk kueri berhasil; nilai yang tidak ditemukan juga mengembalikan 0.

Contoh Respons

{ "code": 0, "message": "success", "data": [ {"identity_value": "user-1", "euid": 10362473, "error_code": 0}, {"identity_value": "user-not-found", "euid": null, "error_code": 0} ] }
              
              {
    "code": 0,
    "message": "success",
    "data": [
        {"identity_value": "user-1", "euid": 10362473, "error_code": 0},
        {"identity_value": "user-not-found", "euid": null, "error_code": 0}
    ]
}

            
Tampilkan blok kode ini di jendela mengambang

Kode Error

Kode Deskripsi
40050 Autentikasi antarmuka gagal.
55004 Parameter bisnis tidak valid.
55101 Jumlah pengenal melebihi 100.
55105 Nilai pengenal melebihi 256 karakter.
55106 Pengenal tidak dikonfigurasi di proyek.
55107 Nama atau nilai pengenal kosong.
55110 Batas permintaan terlampaui (maksimal 1.000 permintaan per menit per proyek).
Icon Solid Transparent White Qiyu
Hubungi Sales