发送消费信息

本 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 服务器：向应用商店传输消费信息

要传输到应用商店的消费信息中，也包含仅存在于应用服务器上的数据。在这种情况下，若要让 Hive 服务器将消费信息传输到应用商店，应用服务器必须先将数据传递给 Hive 服务器。

应用服务器 URL 是应用服务器为向 Hive 服务器传递数据而开放的 API 端点。配置好 API 端点并注册为应用服务器 URL 后，每当用户请求退款时，Hive 服务器都会向该 API 端点发送 POST 请求，并从应用服务器接收所需数据。Hive 服务器会汇总这些数据，并代表应用完成向应用商店传输消费信息。

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 服务器的响应值信息如下。

以下是响应成功时响应值的示例。

// 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."
}

响应代码¶