發送消費信息
使用從附加服務傳輸消費信息,應用程序用戶在請求退款時可以將其消費行為信息發送到應用市場。
Note
目前,消費信息的傳輸僅支持 Apple App Store。
概述¶
要發送到應用市場的消費者信息還包含僅存在於遊戲伺服器上的數據。因此,為了讓Hive伺服器將這些數據發送到應用市場,遊戲伺服器必須將數據傳遞給Hive伺服器。
遊戲伺服器 URL 是 遊戲伺服器開放的 API 端點,用於遊戲伺服器向 Hive 伺服器發送數據。在根據以下協議配置 API 端點並將其註冊到遊戲伺服器 URL 後,每當用戶請求退款時,Hive 伺服器將向此 API 端點發送 POST 請求,並從遊戲伺服器接收必要的數據。Hive 伺服器匯總這些數據,並代表應用開發者完成消費者信息傳輸到應用市場的工作。
總結來說,整個過程如下。
- 應用程式開發者:透過 配置 API 端點 準備伺服器 URL
- 應用程式開發者:在 Hive 控制台中選擇 啟用消費資訊傳輸 並註冊伺服器 URL
- 應用程式使用者:同意在應用程式運行時 傳輸應用內產品消費資訊
- 應用程式使用者:在應用程式中請求退款
- Hive 伺服器:向應用程式開發者註冊的伺服器 URL 發送 POST API 請求,接收數據作為回應
- Hive 伺服器:將消費資訊傳輸到應用市場
Warning
如果應用程式使用者不同意在同意彈出視窗中傳輸資訊,即使Hive伺服器從遊戲伺服器接收到資料,也不會將資料傳輸到應用程式市場。
API 端點配置 (伺服器 URL)¶
要註冊的 API 端點必須在收到請求時聚合遊戲用戶特定數據(consumption_status
、play_time
、refund_preference
、sample_content_provided
),並以聚合數據作為回應,這些數據可以使用請求參數中的用戶信息(CS_CODE
)進行查詢。
禁用防火牆規則¶
禁用防火牆入站規則允許遊戲伺服器與 Hive 伺服器之間的 API 通信。您需要在遊戲伺服器上禁用以下 IP 地址的防火牆入站規則。
Hive 伺服器類型 | IP 地址 |
---|---|
商業 IP | 43.201.165.236 |
沙盒 IP | 43.155.181.83 |
禁用防火牆規則後,請參考以下資訊以配置 API 端點。
API 請求 (Hive 伺服器 → 遊戲伺服器) 配置¶
這是從 Hive 伺服器發送到遊戲伺服器的 POST 請求資訊。
API 資訊 | 描述 |
---|---|
方法 | POST |
回應格式 | JSON |
內容類型 | application/json |
以下是請求主體資訊。
名稱 | 類型 | 必需 (必需: M, 選用: O) | 描述 |
---|---|---|---|
gameindex | 字串 | M | Hive 應用中心遊戲索引 |
appid | 字串 | M | Hive 應用中心 AppID |
user_seq | 字串 | M | 遊戲內用戶 CS 代碼 |
以下是請求主體的範例。
{
"gameindex": "539",
"appid": "com.com2us.hivesdk.normal.freefull.apple.global.ios.universal",
"user_seq": "222333"
}
API 回應 (遊戲伺服器 → Hive 伺服器) 配置¶
這是遊戲伺服器在回應成功時必須發送到 Hive 伺服器的回應值資訊。
名稱 | 類型 | 必需 (必需: M, 可選: O) | 描述 |
---|---|---|---|
代碼 | 整數 | M | 回應代碼 (100: 成功) |
訊息 | 字串 | M | 根據回應代碼的結果訊息 |
數據 | 物件 | M | 回應數據 (僅在回應成功時返回,若出現錯誤則不返回) |
┕ 消耗狀態 | 整數 | M | 消耗品項的消耗狀態 ("0" 或 "3" 必須選擇作為固定值回應) |
┕ 遊玩時間 | 整數 | M | 遊戲遊玩時間 |
┕ 退款偏好 | 整數 | M | 退款偏好 |
┕ 提供的樣本內容 | 整數 | M | 提供的樣本內容狀態 |
以下是當回應成功時的回應值範例。
// success
{
"code": 100,
"message": "OK",
"data": {
"consumption_status": 0,
"play_time": 1,
"refund_preference": 2,
"sample_content_provided": 0
}
}
以下是響應失敗時的響應值示例。
// Errors due to wrong parameters
{
"code": 400,
"message": "No parameter, or invalid parameter name."
}
// Errors due to invalid user information
{
"code": 200,
"message": "No data, or invalid cs_code."
}
這裡是回應代碼。
代碼 | 描述 |
---|---|
100 | 成功 |
200 | 無效的用戶信息 (CS_CODE) |
400 | 請求參數錯誤 |
401 | 請求 JSON 錯誤 |
500 | 伺服器處理錯誤 |
501 | 數據庫通信錯誤 |