配對 API¶
您可以使用配對 API 將 配對 應用於遊戲。
配對 API 主要由 私人配對 API 和 團體配對 API 組成。此外,完成配對後,您可以通過 配對結果回調 API 檢查配對狀態。
前提條件¶
要使用配對 API,必須具備以下項目。
- API 呼叫的身份驗證令牌(
Hive Certification Key):可以在 Hive 控制台的 應用中心 > 專案管理 > 搜尋後選擇應用 > 遊戲詳情 > 基本資訊 > Hive Certification Key 中找到 - 遊戲索引(
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 | 內部伺服器錯誤 | 發生內部伺服器問題 |