匹配 API¶
您可以使用匹配 API 将 匹配 应用到游戏中。
匹配 API 主要由 私有匹配 API 和 组匹配 API 组成。此外,匹配完成后,您可以通过 匹配结果回调 API 检查匹配状态。
先决条件¶
要使用匹配 API,以下项目是必需的。
- API调用的身份验证令牌(
Hive Certification Key
):可以在Hive控制台的应用中心 > 项目管理 > 搜索后选择应用 > 游戏详情 > 基本信息 > Hive认证密钥中找到 - 游戏索引(
gameIndex
):可以在Hive控制台的应用中心 > 项目管理 > 搜索后选择应用 > 游戏详情 > 基本信息 > 游戏索引中找到 - 匹配ID(
matchId
):可以在Hive控制台创建匹配时找到
基本信息¶
这解释了在使用匹配 API 之前您需要了解的基本信息。
请求 URL¶
匹配 API 请求在下面的 URL。
服务器 | 网址 |
---|---|
实时 | api-match.withhive.com |
沙盒 | sandbox-api-match.withhive.com |
响应代码¶
在向匹配 API 发出请求时常用的 HTTP 响应状态代码。
除了响应代码,您还可以在参考中检查Hive服务器提供的错误代码,以防匹配API操作错误。
代码 | 值 | 描述 |
---|---|---|
200 | 成功 | 请参考每个 API 响应 |
400 | 错误请求 | 请求参数或请求体输入无效 |
401 | 未授权 | 请求消息中的授权头缺失或其值无效 |
403 | 禁止 | API 调用的身份验证令牌(Hive 认证密钥)无效 |
404 | 未找到 | API 路径输入无效 |
500 | 内部服务器错误 | 发生了内部服务器问题 |