內(nèi)容設(shè)計
該接口用于系統(tǒng)集成，嵌入自有系統(tǒng)中編輯活動，返回活動編輯頁面地址。
請求地址 | https://open.bydok.cn/api/v1/work/edit | ||
請求方式 | POST | ||
參數(shù)說明 | |||
參數(shù)名稱 | 是否必須 | 類型 | 說明 |
app_key | 是 | string(32) | 人人秀平臺分配的AppKey |
time_stamp | 是 | int(11) | 1970-01-01開始的時間戳，精確到毫秒 |
sign | 是 | string(32) | 根據(jù)簽名算法計算所得，如何計算簽名 |
login_id | 是 | string(60) | 登錄賬號，指定賬號下活動。 查看賬號 |
h5_guid | 是 | string(6) | 作品GUID |
share_info | 否 | obj | 更新活動分享信息，不傳則不更新 |
open_setting | 否 | obj | 更新活動基本設(shè)置，互動類型支持，不傳則不更新 |
share_info參數(shù)說明 （不傳則不更新）
參數(shù)名稱 | 是否必須 | 類型 | 說明 |
title | 否 | string(200) | 活動分享標(biāo)題 |
describe | 否 | string(200) | 活動分享描述 |
share_image_url | 否 | string(200) | 圖片地址，會下載到人人秀 |
open_setting參數(shù)說明（不傳則不更新）
參數(shù)名稱 | 是否必須 | 類型 | 說明 |
start_time | 否 | datetime | 互動活動開始時間，格式例如2024-01-01 00:00:00 |
end_time | 否 | datetime | 互動活動結(jié)束時間，格式例如2099-10-10 23:59:59 |
open_mp | 否 | int(2) | 開啟關(guān)注公眾號參與，1：開啟 |
open_grab | 否 | int(2) | 開啟抽獎，1：開啟，僅游戲類、答題類活動支持 |
grab_limit | 否 | int(11) | 開啟抽獎條件，滿足xx分可抽獎 |
grab_prize_list | 否 | array | 新增抽獎列表管理 |
open_points | 否 | int(2) | 開啟積分參與，1：開啟 |
points | 否 | int(11) | 開啟積分參與，每次消耗積分值 |
open_mp | 否 | int(2) | 開啟關(guān)注公眾號參與，1：開啟 |
grab_prize_list參數(shù)說明（不傳則不更新）
參數(shù)名稱 | 是否必須 | 類型 | 說明 |
product_id | 是 | int(11) | 修改獎品的ID，（創(chuàng)建時返回或通過數(shù)據(jù)接口獲取） 新增獎品時可為0。 |
title | 否 | string(60) | 獎品顯示名稱 |
type | 否 | int(11) | 獎品類型枚舉，1：實(shí)物獎品；2：紅包獎品；6：積分獎品；7：自有獎品；0：非獎品 |
prize_image_url | 否 | string(200) | 圖片地址，會下載到人人秀 |
prize_code | 否 | string(10) | type=4時，自有獎品必傳，建議對接自有獎品庫（需單獨(dú)按需開啟） |
prize_points | 否 | int(11) | type=6時，積分獎品必傳，建議對接自有積分接口（需單獨(dú)按需開啟） |
prize_redpack | 否 | obj | type=2時，紅包獎品必傳 |
prize_win_rate | 否 | float(2) | 獎品中獎概率（0.01~100），所有獎品總概率不超過100 |
prize_count | 否 | int(11) | 獎品數(shù)量，注意更新的數(shù)量不能少于已中獎數(shù)量 |
is_consolation | 否 | int(2) | 安慰獎，僅支持一個，安慰獎不參與計算中獎概率 |
is_delete | 否 | int(2) | 是否標(biāo)記刪除獎品，若獎品已有人領(lǐng)取則不支持刪除 |
prize_redpack參數(shù)說明（不傳則不更新）
參數(shù)名稱 | 是否必須 | 類型 | 說明 |
redpack_type | 否 | int(11) | 紅包類型枚舉，1：固定金額；2：隨機(jī)金額 |
redpack_amount | 否 | float(2) | 選擇固定金額時，必須，金額范圍（0.1 ~ 200）,小于1元紅包需單獨(dú)按需開啟 |
redpack_min_amount | 否 | float(2) | 選擇隨機(jī)金額時，必須，單筆隨機(jī)的最小金額,金額范圍（0.1~200） |
redpack_max_amount | 否 | float(2) | 選擇隨機(jī)金額時，必須，單筆隨機(jī)的最大金額,必須大于最小金額，金額范圍（0.1~200） |
redpack_total_amount | 否 | float(2) | 選擇隨機(jī)金額時，必傳，該獎品總發(fā)放金額 |
返回JSON格式結(jié)果 Content-type: application/json | ||
{"result":0,"msg":"","data":{"url":""}} | ||
參與名稱 | 類型 | 說明 |
result | int(2) | 0表示成功，1表示失敗 |
msg | string(100) | 失敗時，返回的錯誤描述 |
data | obj | 詳情見data參數(shù)說明 |
data參數(shù)說明
參與名稱 | 類型 | 說明 |
url | string(100) | 編輯活動地址 |
prize_list | obj | 活動設(shè)置的獎品列表 |
prize_list參數(shù)說明
參與名稱 | 類型 | 說明 |
grab_prize_list | obj | 抽獎獎品列表，詳見上面 grab_prize_list 參數(shù)說明 |
簽名錯誤，依據(jù)簽名算法檢查簽名
簽名過期，需要重新生成簽名
未登錄，表明登錄狀態(tài)過期，重新登錄或調(diào)用免登錄接口
注意：編輯集成必須使用和免登錄集成同一個iframe容器，以便于保持登錄狀態(tài)一致。代碼示例
已經(jīng)進(jìn)行的活動，若獎品已有人中獎則無法刪除和修改獎品類型
修改獎品必須傳獎品ID，獎品中不需修改值的則不用傳入?yún)?shù)
請求示例
{
"app_key": "96c84928b1dce057d110ea3b3880fc83",
"time_stamp":"1543999047492",
"sign ":"051BF3517D40AB9D7D6B45EF6E4EB7F9",
"login_id ":"zhangsan_02",
"h5_guid": "123456"
}
返回值示例， json格式 Content-type: application/json
{
"result": 0,
"data": {
"url": "https://portal.bydok.cn/p/edit?id=123456#/"，
"prize_list": {
"grab_prize_list": [{
"product_id": 122，
"title": "獎品名稱"，
"prize_code": "code_1"
}]
}，
},
"msg": "ok"
}
