跳轉至

發送消費信息

使用從附加服務傳輸消費信息,當應用用戶請求退款時,您可以將用戶消費行為信息發送到應用市場。此API允許Hive伺服器向開發者的應用伺服器發送請求,然後開發者的伺服器將響應返回給Hive伺服器。

Note

目前,消費信息的傳輸僅支持 Apple App Store。

概述

要發送到應用市場的消費者資訊還包含僅存在於遊戲伺服器上的數據。因此,為了讓 Hive 伺服器將這些數據發送到應用市場,遊戲伺服器必須將數據傳遞給 Hive 伺服器

遊戲伺服器 URL 是 遊戲伺服器開放的 API 端點,供遊戲伺服器將資料發送到 Hive 伺服器。根據以下協議配置 API 端點並將其註冊到遊戲伺服器 URL 後,Hive 伺服器將在每次用戶請求退款時向此 API 端點發送 POST 請求,並從遊戲伺服器接收必要的資料。Hive 伺服器匯總這些資料,並代表應用開發者完成消費者資訊向應用市場的傳輸。

總結來說,整個過程如下。

  1. 應用程式開發者:透過配置API端點準備伺服器URL
  2. 應用程式開發者:在Hive控制台中選擇啟用消費資訊傳輸並註冊伺服器URL
  3. 應用程式使用者:在應用程式運行時同意傳輸應用內產品消費資訊
  4. 應用程式使用者:在應用程式中請求退款
  5. Hive伺服器:向應用程式開發者註冊的伺服器URL發送POST API請求,並接收數據作為回應
  6. Hive伺服器:將消費資訊傳輸到應用市場
Warning

如果應用程式使用者不同意在同意彈出視窗中傳輸資訊,即使從遊戲伺服器接收到資料,Hive 伺服器也不會將資料傳輸到應用程式市場。

API 端點配置 (伺服器 URL)

API 端點必須與伺服器 URL 註冊,當收到請求時,必須聚合遊戲用戶特定數據(consumption_statusplay_timerefund_preferencesample_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 數據庫通信錯誤