玩家验证 Webhook

Aghanim 使用玩家验证 webhook 来通知您的游戏有关玩家登录的信息，需要从您的 webhook 服务器进行确认以允许或拒绝访问游戏中心。本文档详细说明了这些 webhooks 的操作。

Webhook 验证玩家在您游戏中的注册，并可能在玩家与游戏中心交互期间被多次调用。

要求

要使用 Aghanim 的玩家验证 webhooks，您应该按以下配置设置 webhook 服务器：

HTTPS 端点，接受 POST webhook 请求。
监听由 Aghanim 生成并签名的事件。
根据 Player ID 验证玩家与您的数据库，以确定对游戏中心的访问。
响应2xx 状态码和相应的 JSON 负载以获得批准，对于拒绝或错误则使用 4xx 或 5xx。

配置

以下是为处理由 Aghanim 生成的玩家验证事件的端点设计的功能模板：

当您的功能准备好时：

使您的端点可用。
在 Aghanim 帐户中注册您的端点 → 游戏 → Webhooks → 新增 Webhook，选择玩家验证事件类型。

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

事件数据架构

键	类型	描述
`player_id`	`string`	用于玩家认证的唯一玩家 ID。

响应架构

在成功的玩家验证后，您的服务器应返回 2xx 范围内的状态码以及包含玩家数据的以下 JSON 负载：

键	类型	描述	必需吗？
`player_id`	`string`	用于玩家认证的唯一玩家 ID。	是
`name`	`string`	玩家昵称。	是
`attributes`	`Attributes`	Aghanim 期望的基础玩家属性。	是
`avatar_url`	`string`	玩家的头像 URL。	否
`email`	`string`	玩家的电子邮件地址。	否
`banned`	`boolean`	指示玩家是否在游戏中被禁。	否
`segments`	`字符串[]`	玩家所属的分段。	否
`country`	`string`	根据 ISO 3166‑1 的两位国家代码。	否
`custom_attributes`	`CustomAttributes`	自定义玩家属性。	否
`balances`	`Balance[]`	玩家的虚拟货币余额。	否

余额对象

余额对象包含以下字段：

键	类型	描述	必需吗？
`sku`	`string`	在游戏和 Aghanim 两者侧面与虚拟货币相关的项目 SKU。	是
`quantity`	`number`	玩家的货币余额。	是

属性对象

属性对象包含以下字段：

键	类型	描述	必需吗？
`level`	`number`	玩家在游戏中的等级。	是
`platform`	`string`	玩家使用游戏中心的平台。可能的值：`ios`，`android`。	否
`marketplace`	`string`	玩家来自的市场。可能的值：`app_store`，`google_play`，`other`。	否
`soft_currency_amount`	`number`	玩家的软货币余额。	否
`hard_currency_amount`	`number`	玩家的硬货币余额。	否

自定义属性对象

自定义属性对象包含键值对，例如：

{
  "is_premium": true,
  "age": 25,
  "favorite_color": "blue",
  "install_date": "2024-01-01"
}

这些属性随后可以在实时运营或分段中用于构建逻辑条件以定位特定玩家群体。

警告

重要提示：自定义属性必须在游戏 → 玩家属性 中声明。

成功响应示例：

{
  "player_id": "2D2R-OP3C",
  "name": "Beebee-Ate",
  "avatar_url": "https://static-platform.aghanim.com/images/bb8.jpg",
  "attributes": {"level": 2},
  "country": "US"
}

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

要求​

配置​

事件数据架构​

响应架构​

余额对象​

属性对象​

自定义属性对象​

成功响应示例：​

要求

配置