Atur Atribut Pengguna

Alamat Endpoint

POST /v1/user/property

Verifikasi Permintaan

EngageLab REST API menggunakan HTTP Basic Authentication sebagai metode verifikasi. Tambahkan Authorization pada HTTP Header:

              
              Authorization: Basic ${base64_auth_string}

            

base64_auth_string dihasilkan dengan algoritma: base64(api_key:api_secret).

• Nama header adalah "Authorization", dan nilainya berupa pasangan "username:password" yang telah dienkode base64 (dipisahkan dengan titik dua).
• Untuk MA API, username adalah APIKey dan password adalah APISecret. Silakan konfigurasikan sumber data tipe API untuk mendapatkan APIKey dan API Secret.

Contoh Permintaan

Header Permintaan

              
              > POST /v1/user/property
> Content-Type: application/json
> Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==

            

Body Permintaan

              
              {
    "euid": 10362473,
    "type": "set",
    "properties": {
        "user_number_once": 46.2,
        "user_string_once": "refef",
        "user_datetime_once": "2023-12-12 00:56:23"
    }
}

            

Parameter Permintaan

Jenis Operasi

Semua properti dalam satu permintaan menggunakan type yang sama. Nilai yang didukung adalah set, increase, add, remove, delete, setOnce, dan update.

Operasi Array Objek

Untuk object_array, nilai add adalah satu objek JSON dan nilai set adalah array objek JSON. remove dan update mencari elemen dengan $identifier_key dan $identifier_value; kolom pengenal harus merupakan subkolom string atau number yang sudah didefinisikan.

Nilai remove hanya boleh berisi kedua kolom pengenal tersebut:

              
              {
  "euid": 10362473,
  "type": "remove",
  "properties": {
    "devices": {
      "$identifier_key": "device_id",
      "$identifier_value": "ios-001"
    }
  }
}

            

update juga harus menyertakan $new_object yang tidak kosong. Objek tersebut tidak boleh berisi kolom pengenal; kolom dengan nilai null dihapus dari elemen yang cocok. Pengenal harus cocok dengan tepat satu elemen array.

              
              {
  "euid": 10362473,
  "type": "update",
  "properties": {
    "devices": {
      "$identifier_key": "device_id",
      "$identifier_value": "ios-001",
      "$new_object": {
        "model": "iPhone 16",
        "legacy_field": null
      }
    }
  }
}

            

Parameter Respons

Semua Berhasil

              
              {
    "code": 0,
    "message": "success"
}

            

Semua Gagal

              
              {
    "code": 55102,
    "message": "Atribut pengguna tidak valid"
}

            

Kode Error