集成概览
概述¶
- 简要介绍由米拉克尔游戏提供的 游戏开发者米拉克尔游戏 API 集成指南。
连接概述¶
- MiraclePlay API用于游戏内的分数/成就/各种动作等特定数据的RestFul格式WebAPI通信。
- 为了在MiraclePlay中以多种比赛方式进行使用而提供。
连接结构¶
- 游戏内数据存储到数据库后，MiraclePlay将通过Join API和GameData API两种方式来连接比赛所需的数据。
- 此时所需的两个API可以通过分析工具提供给MiraclePlay，而无需单独构建API。
比赛规则¶
- 比赛方式: 存在排名战和锦标赛战两种方式。
- 排名战: 根据参与者的排名给予奖金
- 锦标赛战: 通过个人/团队对战，胜者晋级下一轮
- 统计方式: 将顶分、总分、平均分分为单人/团队两类进行统计。
API对接实现¶
- 加入API：参与比赛时，用于检查账户是否存在的API
- UUID，NickName字段是必需的
- 如果通过分析发送日志，可以用分析提供的“数据确认”API替代加入API
- 可以在分析中定义由UUID，NickName字段组成的新日志，或者用事先定义的‘内容日志’的playerId，userId字段替代UUID，NickName信息
(25.04.07 기준) Join API 设计示例
| 区分 | 说明 | 用途 | 类型 | 组成 |
|---|---|---|---|---|
| UUID | 该用户的唯一ID | MiraclePlay 匹配检查 | POST | 必填 |
| NickName | 存在与否的 true/false 调用 | 检查实际游戏内是否存在 | POST | 必填 |
| ClientVer | 客户端版本信息 | 参与者的游戏最低版本匹配 | POST | 选填 |
| AccessKey | 用于数据安全的 AccessKey | API 调用时必填字段值添加 (可能因制作公司而异) | POST | 选填 |
| API URL |
- GameData API: 用于记录比赛结果的 API
- UUID 字段是必需的
- 其他字段根据游戏和比赛而异
- 如果通过分析工具发送日志，可以用分析工具提供的“数据查询”API替代 GameData API
- 可以在分析工具中定义包含 UUID 和 API 所需字段的新日志，或者用事先定义的“内容日志”的 playerId 字段替代 UUID 信息，其他与内容相关的信息也可以替代 GameData API 所需字段
(25.04.07 기준) DataData API 设计示例
| 区分 | 说明 | 用途 | 类型 | 组成 |
|---|---|---|---|---|
| UUID | 该用户的唯一ID | MiraclePlay 匹配检查 | POST | 必填 |
| NickName | - | (使用 MiraclePlay 的昵称) | POST | 选填 |
| ClientVer | 客户端版本信息 | 参与者游戏时的版本检查 | POST | 选填 |
| Starttime | 游戏开始时间 (GMT) | 比赛结果汇总 | POST | 按游戏 |
| Endtime | 游戏结束时间 (GMT) | 比赛结果汇总 | POST | 按游戏 |
| Score | 记录的结果数据 | 比赛结果汇总 | POST | 按游戏 |
| playTime | 总游戏时间 | 比赛结果汇总 | POST | 按游戏 |
| AccessKey | 数据安全的 AccessKey | API 调用时必填字段值附加 (每个场合的方法可能不同) | POST | 选填 |
其他¶
以上的整体内容可以在奇迹游戏指南中查看。