매치 메이킹 API¶
매치 메이킹 API를 사용하여 게임에 매치 메이킹을 적용할 수 있습니다.
매치 메이킹 API는 크게 개인 매치 API와 그룹 매치 API로 구성됩니다. 또한 매칭 완료 시 매칭 결과 콜백 API를 통해 매칭 상태를 확인할 수 있습니다.
사전 준비 사항¶
매치 메이킹 API를 사용하려면 아래의 항목이 필요합니다.
- API 호출을 위한 Client ID와 Client Secret: 보안키 설정에서 발급
- API 호출을 위한 Access Token(JWT): 위에서 발급한 Client ID와 Client Secret으로 OAuth Token 발급하기 API를 호출하여 발급 (유효 기간 1시간)
- Game Index(
gameIndex): Hive 콘솔의 앱센터 > 프로젝트 관리 > 앱 검색 후 앱 선택 > 게임 상세 > 기본 정보 > Game Index에서 확인 가능 - 매치 ID(
matchId): Hive 콘솔에서 매치 생성 시 확인 가능
Note
매치 메이킹 API는 JWT 인증 방식으로 동작합니다. 모든 API 요청 헤더인 X-Access-Token에 Access Token을 반드시 포함해야 합니다.
기본 정보¶
매치 메이킹 API를 사용하기에 앞서 공통으로 알아야 할 기본 정보를 설명합니다.
Request URL¶
매치 메이킹 API는 아래의 URL로 요청합니다.
| 서버 | URL |
|---|---|
| LIVE | api-match.withhive.com |
| SANDBOX | sandbox-api-match.withhive.com |
응답 코드¶
매치 메이킹 API 요청 시, 공통으로 사용되는 HTTP 응답 상태 코드입니다.
해당 응답 코드 외에, 매치 메이킹 API 동작 오류 시 Hive 서버에서 제공하는 에러 코드는 참고 사항에서 확인하세요.
| 코드 | 값 | 설명 |
|---|---|---|
| 200 | 성공 | 각 API Response 참조 |
| 400 | Bad Request | 잘못된 Request Param 또는 Request Body 입력, 또는 요청 헤더의 X-Access-Token 값이 유효하지 않거나(2202) 만료됨(2203) |
| 401 | Unauthorized | 요청 헤더의 X-Access-Token이 누락됨(2200) |
| 404 | NotFound | 잘못된 API Path 입력 |
| 500 | Internal Server Error | 서버 내부적으로 문제가 발생함 |