發送消費信息

我們提供讓應用程式使用者請求退款時，將使用者消費資訊傳送至 App Store 的 API。

「消費資訊傳輸」 API 採用 Hive 伺服器與應用程式伺服器之間的 Server-to-Server 通訊方式：Hive 伺服器向應用程式伺服器發出消費資訊傳輸請求後，應用程式伺服器會將回應值回傳給 Hive 伺服器。

V1 → V2 變更點¶

與現有的消費資訊傳輸 V1相比，以下是改為串接 V2 API 時的變更摘要。

運作流程¶

「消費資訊傳輸」 API 呼叫與回應的整體運作流程摘要如下。

1. 應用程式：透過設定 API 端點準備伺服器 URL
2. 應用程式：在 Hive 控制台中選擇啟用消費資訊傳輸，並註冊伺服器 URL
3. 應用程式用戶端：在應用程式執行狀態下，同意傳輸應用程式內產品消費資訊
4. 應用程式使用者：在應用程式中請求退款
5. Hive 伺服器：向應用程式註冊的伺服器 URL 發送 POST API 請求，並從應用程式伺服器接收回應值作為消費資訊資料
6. Hive 伺服器：將消費資訊傳輸至 App Store

要傳輸至 App Store 的消費資訊中，也有僅存在於應用程式伺服器上的資料。在這種情況下，若要讓 Hive 伺服器將消費資訊傳輸至 App Store，應用程式伺服器必須先將資料傳遞給 Hive 伺服器。

應用程式伺服器 URL 是應用程式伺服器為了將資料傳遞給 Hive 伺服器，而在應用程式伺服器上開放的 API 端點。配置 API 端點並註冊為應用程式伺服器 URL 後，每當使用者請求退款時，Hive 伺服器就會向此 API 端點發送 POST 請求，並從應用程式伺服器接收所需的資料。Hive 伺服器會彙整這些資料，並代替應用程式完成向 App Store 傳輸消費資訊。

API 端點 (伺服器 URL) 配置¶

應用程式伺服器透過註冊為伺服器 URL 的 API 端點接收請求時，必須彙整應用程式使用者相關資料（consumption_status、play_time、refund_preference、sample_content_provided），並以請求參數中的使用者資訊（CS_CODE）可查詢到的彙整資料作為回應傳回。

解除防火牆規則¶

解除防火牆入站規則，允許應用程式伺服器與 Hive 伺服器之間的 API 通信。您需要在應用程式伺服器上為以下 IP 位址解除防火牆入站規則。

解除防火牆規則後，請參考以下信息配置 API 端點。

API 請求 (Hive 伺服器 → 應用程式伺服器) 配置¶

這是從 Hive 伺服器發送到應用程式伺服器的 POST 請求資訊。

Request body¶

請求本文資訊如下。

請求本文範例如下。

{
    "gameindex": "539",
    "appid": "com.com2us.hivesdk.normal.freefull.apple.global.ios.universal",
    "user_seq": "222333"
}

API 回應 (應用程式伺服器 → Hive 伺服器) 配置¶

這是應用程式伺服器回傳給 Hive 伺服器的資訊。

Response body¶

回應成功時，應用程式伺服器必須傳遞給 Hive 伺服器的回應值資訊如下。

回應成功範例如下。

// 成功時
{
    "code": 100,
    "message": "OK",
    "data": {
        "consumption_status": 0,
        "play_time": 1,
        "refund_preference": 2,
        "sample_content_provided": 0
    }
}

回應失敗範例如下。

// 參數錯誤導致發生錯誤的情況
{
    "code": 400,
    "message": "No parameter, or invalid parameter name."
}

// 使用者資訊 (CS_CODE) 無效的情況
{
    "code": 200,
    "message": "No data, or invalid cs_code."
}

回應代碼¶