이용 정지 게임 서버 등록

이용 정지 유저 정보 전달 API는 이용정지 유저의 정보를 등록하거나 변경할 때, 해당 정보를 게임 서버로 자동으로 전달하는 기능을 제공합니다. 이 API를 통해 게임 서버로 실시간으로 이용정지 유저 정보를 수신할 수 있습니다.

정보 전달 시점: 이용 정지 유저의 정보가 새로 등록되거나 변경될 때 자동으로 게임 서버로 전달됩니다. 이용 정지 해제 시에는 API를 통해 정보가 전달되지 않습니다.
정보 전송 단위: 한 번의 요청(Request)으로 최대 100건의 이용 정지 유저 정보가 전송됩니다. 예를 들어, 이용 정지 유저가 2,000명이라면 100명씩 나누어 총 20번의 Request가 게임 서버로 전송됩니다.

이용 정지 유저 정보 전달 API를 사용하려면 요청(Request)을 받을 수 있도록 게임 서버를 준비해야 합니다. 게임 서버 등록은 Hive 콘솔에서 아래의 경로를 통해 설정할 수 있습니다.

경로: Hive 콘솔 > 인증 > 이용정지 > 게임서버 등록

Basics¶

	설명
Request URL	Hive 콘솔 게임 서버에 등록한 프로젝트의 게임 서버의 URL : [Hive 콘솔 > 인증 > 이용정지 > 게임 서버 등록]
HTTP Method	POST
Content-type	application/json
Data Format	JSON
Authorization	Bearer `게임 서버 인증키`

Note

Bearer 토큰은 [Hive 콘솔 인증 > 이용정지 > 게임 서버 등록 > 프로젝트 상세 > 게임 서버 인증키]에 해당합니다.
게임 서버 인증키 검증은 요청받는 게임 서버에서 검증하도록 개발해야 합니다.

Request¶

명칭	타입	필수 여부	설명
game_index	Integer	O	게임 인덱스
server_url	String	O	게임 서버 URL
data	List	O	이용정지 유저 목록
data.player_id	Integer	O	플레이어 아이디
data.status	String	O	이용정지 상태 P: 영구 이용 정지 B: 이용 정지 기간이 있는 유저
data.start_date	String	O	이용 정지 시작일
data.end_date	String	O	이용 정지 종료일

Response¶

명칭	타입	설명	비고
result_code	Integer	결과 코드	0: 정상 그 외 코드는 전부 에러 (게임 서버에서 응답하는 코드)

Request examples¶

curl -X POST {Hive 콘솔 게임 서버에 등록한 프로젝트의 게임 서버의 URL}
    -H 'Content-Type: application/json'
    -H 'Authorization: Bearer {Hive 콘솔 게임 서버 등록 시에 발급 받은 게임 서버 인증키}'
    -d '{"game_index": 539, "server_url": "{Hive 콘솔 게임 서버에 등록한 프로젝트의 게임 서버의 URL}", "data": [{"player_id": 1, "status": "B", "start_date": "2024-07-10 20:56:59", "end_date": "2024-07-13 20:56:59"}, {"player_id": 2, "status": "B", "start_date": "2024-07-10 20:56:59", "end_date": "2024-07-20 20:56:59"}, {"player_id": 3, "status": "P", "start_date": "2024-07-10 20:56:59", "end_date": "9999-12-31 00:00:00"}]}'

Request JSON examples¶

{
  "game_index": 539,
  "server_url": "{Hive 콘솔 게임 서버에 등록한 프로젝트의 게임 서버의 URL}",
  "data": [
    {
      "player_id": 1,
      "status": "B",
      "start_date": "2024-07-10 20:56:59",
      "end_date": "2024-07-13 20:56:59"
    },
    {
      "player_id": 2,
      "status": "B",
      "start_date": "2024-07-10 20:56:59",
      "end_date": "2024-07-20 20:56:59"
    },
    {
      "player_id": 3,
      "status": "P",
      "start_date": "2024-07-10 20:56:59",
      "end_date": "9999-12-31 00:00:00"
    }
    .
    .
    .
    (최대 100 건의 이용 정지 유저 전송. EX) 2,000 건의 이용 정지 유저가 등록된 경우 100 건씩 총 20번 게임 서버 전송 Request가 발생됩니다.)
  ]
}

Response JSON examples¶

{
  "result_code": 0
}