Skip to content

Matchmaking API

You can apply matchmaking to the game using the Matchmaking API.

The matchmaking API is mainly composed of the Private Match API and the Group Match API. Additionally, upon completion of the matching, you can check the matching status through the Matching Result Callback API.

Prerequisites

To use the matchmaking API, the following items are required.

  • Authentication token for API calls (Hive Certification Key): Can be found in the Hive console under App Center > Project Management > Select App after searching > Game Details > Basic Information > Hive Certification Key
  • Game index (gameIndex): Can be found in the Hive console under App Center > Project Management > Select App after searching > Game Details > Basic Information > Game Index
  • Match ID (matchId): Can be found when creating a match in the Hive console

Basic information

This explains the basic information that you need to know in common before using the matchmaking API.

Request URL

The matchmaking API requests at the URL below.

Server URL
LIVE api-match.withhive.com
SANDBOX sandbox-api-match.withhive.com

Response code

The HTTP response status codes commonly used when making requests to the matchmaking API.

In addition to the response code, you can check the error codes provided by the Hive server in case of matchmaking API operation errors in the reference.

Code Value Description
200 Success Refer to each API Response
400 Bad Request Invalid Request Param or Request Body input
401 Unauthorized The Authorization header in the request message is missing or its value is invalid
403 Forbidden The authentication token (Hive Certification Key) for API calls is invalid
404 Not Found Invalid API Path input
500 Internal Server Error An internal server issue has occurred