跳到主要内容

获取商店 Webhook

store.get webhook 用于检索 Game Hub 商店中为玩家提供的商品列表。 这对于根据游戏逻辑显示商店内容非常有用。

以下情况会触发此 webhook：

  • 玩家登录游戏中心。
  • 玩家打开商店。
  • 玩家进行购买。
获取商店 webhook获取商店 webhook

要求​

要使用 Aghanim 的 store.get webhook，您应按如下方式配置 webhook 服务器：

  • HTTPS 终端，接受 POST webhook 请求。
  • 监听由 Aghanim 生成并签名的事件。
  • 以 2xx 状态码响应，表示成功处理;4xx 或 5xx 表示拒绝或错误。

配置​

  1. 开发用于处理 store.get webhook 的功能。
  2. 确保您的端点可用。
  3. 在 Aghanim 帐户中注册端点 → 游戏 → Webhooks → 新建 Webhook，选择 store.get 事件类型。

或者，您可以使用 Create Webhook API 方法在 Aghanim 中注册端点。

请求架构

下面是一个例子的 store.get webhook请求：

POST /your/webhook/uri HTTP/1.1
Content-Type: application/json
Host: your-webhook-endpoint.com
User-Agent: Aghanim/0.1.0
X-Aghanim-Signature: 2e45ed4dede5e09506717490655d2f78e96d4261040ef48cc623a780bda38812
X-Aghanim-Signature-Timestamp: 1725548450

{
  "event_type": "store.get",
  "event_data": {
    "player_id": "2D2R-OP3C"
  },
  "event_time": 1725548450,
  "event_id": "whevt_eCacGbJVbvToOgzjXUgOCitkQE",
  "idempotency_key": null,
  "request_id": "d1593e9c-c291-4004-8846-6679c2e5810b",
  "sandbox": false,
  "trigger": "hub.login",
  "transaction_id": "whtx_eCacGbJVbvT"
}

The Event schema

键类型描述
event_idstring由 Aghanim 生成的唯一事件 ID。
event_typestring事件的类型， store.get 在这种情况下。
event_timenumber事件日期为 Unix 纪元时间。
event_dataobject包含事件特定数据，可能包括继承对象的键。
idempotency_keystring|null该幂等性键作为 UUID 版本 4 或空值取决于事件类型。
request_idstring|null如果事件是由 API 请求触发的，则包括请求 ID。
sandboxboolean指示事件是否从沙盒游戏环境发送。
triggerstring包含导致事件发送的事件类型的触发器。例如： hub.login.
transaction_idstring由 Aghanim 生成的交易 ID。在同一事务中发出的多个事件可能具有相同的 ID。

事件数据架构​

键类型描述
player_idstring用于玩家身份验证的唯一玩家 ID。
                     |

响应架构​

成功响应时，服务器应返回 2xx 范围内的状态码和以下 JSON 有效载荷：

键类型描述必需？
itemsItem[]商店中可供玩家使用的商品数组。是

商品架构​

键类型描述必需？
skustring游戏和 Aghanim 侧都匹配的商品SKU。是
start_at`number\null`玩家可以获取商品的 unix 时间戳。
end_at`number\null`商品过期且不再对玩家提供的 unix 时间戳。

成功响应示例：​

{
  "items": [
    {
      "sku": "crystals"
    },
    {
      "sku": "shield",
      "start_at": 1630000000,
      "end_at": 1635000000
    }
  ]
}

需要帮助吗？
联系我们的集成团队 integration@aghanim.com