이용 정지 등록 및 해제
앱 운영 정책에 따라 Hive 서버에서 사용자 계정을 이용 정지 상태로 등록하거나 해제하는 API입니다.
'이용 정지 등록 및 해제' 기능으로 제공되는 API는 아래와 같습니다.
| API Endpoint | 설명 |
POST /v2/game/block/set | 이용 정지 등록 |
POST /v2/game/block/delete | 이용 정지 해제 |
게임 서버 전송
Hive 콘솔 > 인증 > 이용 정지 > 게임 서버 등록에 게임 서버가 등록되어 있으면, 이 API로 이용 정지를 등록하거나 해제할 때 해당 정보가 게임 서버로 자동 전달됩니다. 자세한 내용은 이용 정지 게임 서버 등록을 참고하세요.
이용 정지 등록
Hive 콘솔 또는 이용 정지 유형 등록 API를 통해 이용 정지 유형을 사전에 등록하면, 영구 이용 정지 사용자와 기간 제한이 있는 이용 정지 사용자를 구분해 등록할 수 있습니다. 또 기존에 등록한 사용자(PlayerID로 구분)의 이용 정지 유형과 이용 정지 기간을 변경할 수 있습니다.
Request URL
| 필드명 | 설명 | 타입 | 필수 여부 |
| X-Access-Token | 앱 서버 인증을 위한 OAuth 2.0 Access Token (OAuth Token 발급하기 참고) | String | Y |
| ISCRYPT | 데이터 암호화 여부 (0 = 암호화 안 함, 반드시 0으로 전달) | Integer | Y |
Request body
| 필드명 | 설명 | 타입 | 필수 여부 |
| appid | App ID | String | Y |
| player_id | Player ID | Integer | Y |
| status | 이용 정지 상태
P: 영구 이용 정지B: 이용 정지 기간이 있는 사용자
| String | Y |
| block_type | 이용 정지 유형 번호 [Hive 콘솔 > 인증 > 이용 정지 > 유형 등록] 또는 이용 정지 유형 등록 API에서 먼저 등록해야 합니다. | Integer | Y |
| start_date | 이용 정지 시작일 (형식: YYYY-MM-DD HH:mm:ss) | String | Y |
| end_date | 이용 정지 종료일 (형식: YYYY-MM-DD HH:mm:ss) | String | Y |
| skip_blocked | true로 요청하면 기존 차단 데이터가 이미 있는 경우 차단 데이터를 변경하지 않고 result_code=0을 반환합니다. | Boolean | N |
| did | 앱 설치 시 생성되는 앱 식별자입니다. 동일한 종류의 앱을 식별할 때 사용합니다. SDK 초기화 시 새로 발급되거나 이미 존재하는 값을 반환받아 전달하면 해당 기기의 로그인 이력을 검증합니다. | Integer | N |
Request example
기간 제한 이용 정지 사용자를 등록할 때는 status를 B로 지정하고 start_date, end_date를 함께 전달하세요.
{
"appid": "com.com2us.hivesdk.normal.freefull.apple.global.ios.universal",
"player_id": 24000000000,
"status": "B",
"block_type": 18,
"start_date": "2024-06-03 00:00:00",
"end_date": "2024-06-30 23:59:59",
"skip_blocked": true,
"did": 2000000
}
Response body
| 필드명 | 설명 | 타입 |
| result_code | 응답 코드 자세히 | Integer |
| result_msg | 결과 메시지 | String |
| token_validation | JWT 검증 결과 (JWT 검증 에러) | Object |
| token_validation.result_code | JWT 검증 결과 코드 | Integer |
| token_validation.result_msg | JWT 검증 결과 메시지 | String |
응답 코드
| 코드값 | 설명 |
| 0 | 성공 |
| 2499 | JWT 검증 실패 (token_validation 참고) |
| 4000 | 유효하지 않은 파라미터
- 이용 정지 시작일과 종료일의 형식이 올바르지 않은 경우
- 시작일이 종료일보다 큰 경우
- 현재 시간이 종료일보다 큰 경우
|
| 4011 | 미등록 유형 |
| 4013 | did 로그인 이력 검증 실패 (로그아웃 상태에서는 검증 불가) |
| 6000 | 유효하지 않은 appid |
Response example
성공
{
"result_code": 0,
"result_msg": "SUCCESS",
"token_validation": {
"result_code": 0,
"result_msg": "success"
}
}
이용 정지 해제
특정 계정이 이용 정지된 상태를 Hive 서버에서 직접 해제합니다.
Request URL
| 필드명 | 설명 | 타입 | 필수 여부 |
| X-Access-Token | 앱 서버 인증을 위한 OAuth 2.0 Access Token (OAuth Token 발급하기 참고) | String | Y |
| ISCRYPT | 데이터 암호화 여부 (0 = 암호화 안 함, 반드시 0으로 전달) | Integer | Y |
Request body
| 필드명 | 설명 | 타입 | 필수 여부 |
| appid | App ID | String | Y |
| player_id | Player ID | Integer | Y |
Request example
{
"appid": "com.com2us.hivesdk.normal.freefull.apple.global.ios.universal",
"player_id": 24000000000
}
Response body
| 필드명 | 설명 | 타입 |
| result_code | 응답 코드 자세히 | Integer |
| result_msg | 결과 메시지 | String |
| token_validation | JWT 검증 결과 (JWT 검증 에러) | Object |
| token_validation.result_code | JWT 검증 결과 코드 | Integer |
| token_validation.result_msg | JWT 검증 결과 메시지 | String |
응답 코드
| 코드값 | 설명 |
| 0 | 성공 |
| 2002 | 이용 정지 미등록 사용자 |
| 2499 | JWT 검증 실패 (token_validation 참고) |
| 4000 | 유효하지 않은 파라미터 |
| 6000 | 유효하지 않은 appid |
Response example
성공
{
"result_code": 0,
"result_msg": "SUCCESS",
"token_validation": {
"result_code": 0,
"result_msg": "success"
}
}
Note
JWT 검증 실패 시, token_validation 필드로 자세한 오류 정보를 확인할 수 있습니다. 자세한 내용은 JWT 검증 에러 코드를 참고하세요.