マッチメイキングAPI¶
マッチメイキングAPIを使用して、ゲームにマッチメイキングを適用できます。
マッチメイキングAPIは主にプライベートマッチAPIとグループマッチAPIで構成されています。さらに、マッチングが完了すると、マッチング結果コールバックAPIを通じてマッチングステータスを確認できます。
前提条件¶
マッチメイキングAPIを使用するには、以下の項目が必要です。
- API呼び出しのための認証トークン(Hive Certification Key):Hiveコンソールのアプリセンター > プロジェクト管理 > 検索後にアプリを選択 > ゲーム詳細 > 基本情報 > Hive Certification Keyで見つけることができます
- ゲームインデックス(gameIndex):Hiveコンソールのアプリセンター > プロジェクト管理 > 検索後にアプリを選択 > ゲーム詳細 > 基本情報 > ゲームインデックスで見つけることができます
- マッチID(matchId):Hiveコンソールでマッチを作成するときに見つけることができます
基本情報¶
これは、マッチメイキングAPIを使用する前に知っておくべき基本情報を説明します。
リクエストURL¶
マッチメイキングAPIは、以下のURLでリクエストします。
| サーバー | URL | 
|---|---|
| ライブ | api-match.withhive.com | 
| サンドボックス | sandbox-api-match.withhive.com | 
レスポンスコード¶
マッチメイキングAPIにリクエストを送信する際に一般的に使用されるHTTPレスポンスステータスコード。
マッチメイキングAPI操作エラーの場合、応答コードに加えて、Hiveサーバーが提供するエラーコードをリファレンスで確認できます。
| コード | 値 | 説明 | 
|---|---|---|
| 200 | 成功 | 各APIレスポンスを参照してください | 
| 400 | 不正なリクエスト | 無効なリクエストパラメータまたはリクエストボディ入力 | 
| 401 | 認証されていません | リクエストメッセージのAuthorizationヘッダーが欠落しているか、その値が無効です | 
| 403 | 禁止されています | API呼び出しのための認証トークン(Hive認証キー)が無効です | 
| 404 | 見つかりません | 無効なAPIパス入力 | 
| 500 | 内部サーバーエラー | 内部サーバーの問題が発生しました |