管理 API 工作流

管理 API 工作流

管理 API 使开发者能够创建和管理 Amazon GameOn 竞赛。

管理 API 概览

管理 API 提供添加竞赛、创建奖励名单、创建要求组和结束竞赛的方法。

我们建议您使用管理控制台来创建和管理竞赛。但是,一些高级功能目前在管理控制台中不可用。例如,您需要使用管理 API 创建奖品并定义要求组。

对战、玩家和尝试次数限制

许多相互关联的参数决定竞赛中的玩家、对战和玩家的最大尝试次数。请注意以下定义:

matchesMax:每个竞赛的最大对战数。每个对战复制其父竞赛的开始日期、结束日期和要授予的奖品。具有 10 个对战的竞赛还具有 10 个排行榜、10 个一等奖获得者等。对于每个竞赛单个对战的最简单方案,设置 matchesMax = 1。范围:1 - 10,000。

matchesPerPlayer:单个玩家能够加入竞赛中的多个对战 (对于提供了多个对战的竞赛)。范围:1 - 10,000 或 matchesMax (取较小值)。

playerAttemptsPerMatch:玩家在对战中可以尝试玩的最大次数,通常也是玩家在该对战中可以提交分数的次数。范围:1 - 1,000,000,000

playersPerMatch:对战及其排行榜中的最大玩家数。最大限制:1,000,000,000

管理 API 工作流

要使用管理 API,您需要在请求标头中提供管理 API 密钥。您可以在管理控制台的游戏设置面板中找到游戏 API 密钥。请参见下图:

创建奖品

可为竞赛创建两种类型的奖品:数字和实物。数字奖品由开发者兑现,可以按照下面的描述进行创建。实物奖品由 Amazon.com 兑现,玩家可以通过我们在领取奖品方法中返回的 Web 链接进行领取。Amazon.com 上由亚马逊销售或兑现的大部分产品都符合作为实物奖品的条件。要为竞赛创建实物奖品,请使用此申请表提交申请。

{
  "prizes": [
    {
      "description": "这个宝箱里面的宝物比银色宝箱里面的更好。",
      "imageUrl": "https://s3.amazonaws.com/tournament-prizes/Prize-Item-1.png",
      "title": "金色宝箱",
      "prizeInfo": "GOLDEN_CHEST_0124"
    },
    {
      "description": "有了这个治疗药水包,您永远都会保持健康。",
      "imageUrl": "https://s3.amazonaws.com/tournament-prizes/Prize-Item-1.png",
      "title": "100 点生命值药水",
      "prizeInfo": "HEALTH_POTIONS_100"
    }
  ]
}

创建要求组

使用添加需求列表方法创建要求组。在请求正文中定义字段。有四种不同类型的要求。有关详细信息,请参阅要求类型。您可以在同一列表中组合不同的类型,如以下示例所示:

{
  "requirements": [
    {
      "name": "玩家是 VIP",
      "description": "玩家具有 VIP 身份。",
      "type": "value",
      "key": "status",
      "value": "VIP"
    },
    {
      "name": "玩家是新手",
      "description": "玩家的技能在 0 到 10 之间。",
      "type": "range",
      "key": "League",
      "high": 10,
      "low": 0
    },
    {
      "name": "大西雅图地区",
      "description": "玩家的 GPS 坐标位于大西雅图地区",
      "type": "gps",
      "key": "gpsCoordinates",
      "permittedAreas": [
        {
          "gpsCoordinates": {
            "latitude": 47.60604,
            "longitude": -122.3328
          },
          "radius": 10,
          "radiusUnits": "KILOMETERS"
        }
      ]
    }
  ]
}