Quick Audience:Manajemen Webhook

Buat Parameter

1. Pilih Workspace> Manajemen Konfigurasi > Konfigurasi Pemasaran > Manajemen Webhook > Manajemen Parameter Webhook.

   

2. Di pojok kanan atas, klik Buat Parameter Webhook.

3. Konfigurasikan parameter di jendela pop-up. Metode konfigurasi parameter konstan dan API berbeda:

   • Tipe API:

     

     Item	Nilai contoh
     Parameter	Masukkan nama API.
     Tipe Parameter	Pilih Tipe API.
     Referensi	Masukkan alamat API tempat parameter dilewatkan.
     Deskripsi	Deskripsi parameter input.
     Metode autentikasi.	Pilih metode autentikasi: Tidak ada: Tidak dilakukan autentikasi. Kunci: Kunci verifikasi digunakan untuk autentikasi. Anda perlu memasukkan kunci di bawah ini.
     Apakah akan mengaitkan parameter lain	Pilih parameter terkait: Tidak: tidak terkait Ya: Pengaturan nilai parameter (Anda dapat menambahkan beberapa parameter, hingga 20): Nama Parameter: Nama parameter harus dalam bahasa Inggris, dan dapat mencapai panjang maksimal 32 karakter serta dapat berisi huruf, digit, dan garis bawah. Nama tampilan: hingga 32 karakter Nilai parameter: Opsi drop-down, opsi yang didukung: pemilihan parameter terkait, input manual Pemilihan Parameter Terkait Drop-down parameter penuh di bawah manajemen parameter Jika Anda perlu menetapkan hubungan kaskade untuk parameter tipe API, API harus berisi hubungan kaskade antar parameter. Input Manual: Jika Anda memilih Input Manual, Anda dapat secara manual memasukkan beberapa nilai parameter. Jika Anda perlu melewati beberapa nilai untuk satu parameter, Anda dapat mengisi satu nilai parameter, pisahkan beberapa nilai dengan pemisah yang disepakati oleh tiga pihak, dan pisahkan setelah diterima

   • Tipe Konstan:

     

     

     Item	Nilai contoh
     Parameter	Masukkan nama API.
     Tipe Parameter	Pilih Tipe Konstan.
     Deskripsi	Deskripsi parameter input.
     Apakah akan mengaitkan parameter lain	Pilih parameter terkait: Tidak: pengaturan nilai parameter (beberapa dapat ditambahkan, hingga 20) Nilai Parameter: Setidaknya satu parameter template dikonfigurasi. Nama parameter harus dalam bahasa Inggris dan tidak boleh kosong. Nama parameter harus memiliki panjang maksimal 32 karakter. Nama tampilan: hingga 32 karakter Ya: nilai parameter dan pengaturan parameter terkait (Anda dapat menambahkan beberapa parameter, hingga 20)

4. Klik OK.

Manajemen Parameter

Daftar parameter menyediakan tombol tindakan berikut:

• Detail: Klik untuk melihat detail parameter.

• Edit: Klik untuk mengedit parameter. Metode konfigurasi sama dengan saat Anda membuat parameter.

• Hapus: Klik untuk menghapus parameter. Di kotak dialog yang muncul, klik OK. Anda hanya dapat menghapus parameter yang tidak digunakan.

Server Endpoint HTTP

Untuk terhubung ke Webhook Quick Audience, Anda perlu mengembangkan server HTTP. Quick Audience memulai permintaan Post dengan periode timeout 10 detik. Tabel berikut menyediakan parameter umum untuk permintaan Post yang dimulai oleh Quick Audience dan permintaan penerimaan. Parameter tersebut diperlukan.

Contoh URL permintaan:

{URL Webhook yang dikonfigurasi}?timestamp=1631865523&nonce=2 e6eceb5737b473284c930c8ef79090e

Metode autentikasi.

Kunci digunakan untuk autentikasi. Autentikasi diaktifkan selama konfigurasi Webhook, dan pengguna mengisi kunci.

Quick Audience menggunakan parameter permintaan timestamp dan nonce, kunci dan URL untuk menandatangani tanda tangan HmacSHA256Hex dan menghasilkan tanda tangan. Tanda tangan dilewatkan ke header permintaan untuk autentikasi. Setelah layanan Anda menerima permintaan, itu menggunakan algoritma HmacSHA256Hex untuk mengenkripsi permintaan berdasarkan parameter URL dan kunci yang dikonfigurasikan untuk saluran Webhook. Jika nilai yang dihitung sama dengan tanda tangan yang dilewatkan di header Permintaan, Anda dapat menentukan bahwa permintaan dikirim dari Quick Audience. Hal yang sama berlaku saat mengirimkan penerimaan.

Contoh algoritma tanda tangan:

import org.apache.commons.codec.digest.HmacUtils;

public String makeSignature(String key, String timestamp, String nonce) {
    String str = generateStr(key, timestamp, nonce);
    return HmacUtils.hmacSha256Hex(key, str.replaceAll("\\s+", ""));
}

/**
 * Tandatangani penggabungan string yang akan diproses.
 */
public static String generateStr(String key, String timestamp, String nonce) {
    String[] array= new String[]{key, timestamp, nonce};
    StringBuilder sb = new StringBuilder();
    Arrays.sort(array);/* Urutkan string * /
    for (int i = 0; i < 3; i++) {
        sb.append(array[i]);
    }
    return sb.toString();
}

Permintaan Webhook

Permintaan tersebut adalah permintaan HTTP Post yang dimulai oleh Quick Audience ke pihak akses. Badan permintaan adalah informasi permintaan pemicu untuk satu pengguna. Saat mengirim permintaan, semua bidang dari tipe apa pun (seperti bilangan bulat, string, dan variabel teks) dikonversi menjadi string untuk diproses.

Contoh struktur Post Body (1 hingga 100 untuk satu pengguna):

[
    {
        "user_profile": {
            "target_type": "OPEN_ID",
            "target_id": "1917810",
            "customer_id": "ID unik pelanggan. ID ini diperlukan untuk pelaporan acara"
        },
        "params": {
            "define_item1": "ID Kupon",
            "define_item2": "Contoh isi kupon. Alamat pengguna adalah Beijing"
        },
        "callback_params": {
            "Webhook_id": "13312313",
            "send_time": "1625037472000",
            "nodeId": "Node Id",
            "instanceId": "Instance Id",
            "batchId": "ID batch tempat tindakan dilaksanakan. ID dapat berupa ID idempoten batch",
            "actionId": "ID instance tindakan. Parameter ini dapat berupa ID idempoten tunggal",
            "customerId": "User Id,customerId"
        },
        "process_info": {
            "processInstanceId": "Versi baru: ID instance perjalanan setiap pengguna dalam siklus perjalanan",
            "processInstanceStartTime": "Versi baru: waktu mulai instance perjalanan untuk setiap pengguna dalam periode perjalanan, dalam format timestamp",
            "processNodeInstanceId": "Versi baru: ID instance node perjalanan (berbeda setiap kali)",
            "processNodeInstanceStartTime": "Versi baru: Waktu mulai instance node perjalanan setiap pengguna dalam periode perjalanan, dalam format timestamp",
            "groupName":"nodeId:nodeName:groupResult(node.result),groupName(node.resultExt);nodeId:nodeName:groupResult(node.result),groupName(node.resultExt)",
            "@comment":{
              "groupName" : "id node: nama node (dikonfigurasikan pada API): hasil pengelompokan (persentase angka pengelompokan acak, dua desimal): nama grup (dikonfigurasikan pada API); pisahkan beberapa dengan titik koma"
            }
        }
    }
]

Tipe ID yang didukung:

Setelah menerima permintaan, pihak akses mengembalikan pesan respons ke Quick Audience.

Format badan respons:

{
 "code":"OK", // Kode status permintaan: Jika OK dikembalikan, permintaan berhasil dan harus dalam huruf besar. Jika tidak, kode kesalahan dikembalikan dan disesuaikan oleh pihak akses. 
  "message":"", // Deskripsi kode status. Bidang ini opsional. 
}

Pelaporan Penerimaan

Setelah titik akses mengeksekusi tugas pemasaran, titik akses melaporkan penerimaan ke Quick Audience untuk memberikan umpan balik hasil pengiriman pesan pemasaran.

Untuk informasi lebih lanjut, lihat API Platform Terbuka Quick Audience.

Catatan Penggunaan

WebhookCallBackMessage adalah sebagai berikut:

WebhookCallBackResult adalah sebagai berikut:

OemImportTaskInfoResponse adalah sebagai berikut:

Contoh permintaan

curl -H "X-QA-Hmac-Signature: 12" -H "Authorization: 57a824b183e54ddbca79170c00dd3f72" -H "Content-Type: application/json" -H "Cookie: csrf_token=f5013e65-0661-41ba-b2ad-8a396a775533" --data-binary "[
    {
        \"msgId\": \"1\"
    }
]" --compressed "http://qa.qa-env09.aliyun.com/openapi/cloud/Webhook/receiveWebhookCallBack?nonce=12&appId=686219778252592361&accessKey=c76f6d5cb309478ab9929616dba64148&timestamp=1718352394665"

Contoh respons:

• {

  "data": {

  "code": 200,

  "message": "Success"

  },

  "errorCode": null,

  "errorDesc": null,

  "exStack": null,

  "opers": [],

  "solution": null,

  "success": true,

  "traceId": "0ada03af17183523948084322d00b4"

  }

Apa perbedaan antara parameter Webhook, variabel, konstanta, dan API?

A: Ada beberapa jenis parameter Webhook. Gambar berikut menunjukkan perbedaan dan penggunaannya.

Deskripsi:

• Konstanta dan API adalah dua cara untuk memberikan nilai kepada parameter karakter (parameter panggilan).

• Variabel disisipkan dalam parameter tipe teks dan dapat diubah oleh pengguna.