이용 정지 유형 등록 및 해제¶
이용 정지 유형을 Hive 서버에 등록하거나 삭제하는 API입니다.
'이용 정지 유형 등록 및 해제' 기능으로 제공되는 API는 아래와 같습니다.
| API Endpoint | 설명 |
|---|---|
POST /v2/game/block/type/set | 이용 정지 유형 등록 |
POST /v2/game/block/type/delete | 이용 정지 유형 해제 |
이용 정지 유형 등록¶
이용 정지 시 적용할 유형을 Hive 서버에 등록합니다. 등록된 유형은 이용 정지 등록 API에서 이용 정지 유형 번호(block_type) 파라미터로 사용합니다. 팝업 형식은 운영 정책 제한(type_status=O)과 임시 제한(type_status=N) 중 선택하며, 한국어와 영어는 필수 등록 언어입니다. 콘솔 가이드 인증 > 이용 정지 > 유형 등록을 참고하세요.
Request URL¶
| 상용 URL | https://auth.qpyou.cn/v2/game/block/type/set |
|---|---|
| Sandbox URL | https://sandbox-auth.qpyou.cn/v2/game/block/type/set |
| HTTP Method | POST |
| Content-Type | application/json |
| Data Format | JSON |
Request header¶
| 필드명 | 설명 | 타입 | 필수여부 |
|---|---|---|---|
| X-Access-Token | 앱 서버 인증을 위한 OAuth 2.0 Access Token (OAuth Token 발급하기 참고) | String | Y |
| ISCRYPT | 데이터 암호화 여부 (0 = 암호화 안 함) (무조건 0으로 전달) | Integer | Y |
Request body¶
| 필드명 | 설명 | 타입 | 필수여부 |
|---|---|---|---|
| appid | App ID | String | Y |
| type_status | 이용 정지 팝업 형식
| String | Y |
| type_name | 이용 정지 유형명 (한국어) 최대 200 bytes까지 등록 가능합니다. | String | Y |
| type_en_name | 이용 정지 유형명 (영어) 최대 200 bytes까지 등록 가능합니다. | String | Y |
| reasons | 이용 정지 사유 목록 (언어별 메시지 배열) | Array | Y |
| reasons[].language | 언어 코드
| String | Y |
| reasons[].title | 이용 정지 사유 제목type_status=N(임시 제한)일 때는 반드시 전달해야 하며, type_status=O(운영 정책 제한)일 때 전달하면 오류가 발생합니다.최대 200 bytes까지 등록 가능합니다. | String | 조건부 |
| reasons[].reason | 이용 정지 사유 내용 운영 정책 제한( type_status=O)일 경우 최대 200 bytes까지, 임시 제한(type_status=N)일 경우 최대 400 bytes까지 등록 가능합니다. | String | Y |
Request example¶
운영 정책 제한 유형 등록 요청¶
운영 정책 제한 유형을 등록할 때 이 요청을 사용하세요. type_status 값을 O로 설정하고 언어별 이용 정지 사유 내용을 함께 전달하세요.
{
"appid": "com.com2us.hivesdk.normal.freefull.apple.global.ios.universal",
"type_status": "O",
"type_name": "불법 프로그램 이용",
"type_en_name": "Usage of unauthorized programs",
"reasons": [
{"language": "ko", "reason": "불법 프로그램 이용"},
{"language": "en", "reason": "Use of Unauthorized Programs"},
{"language": "ja", "reason": "使用非法程序"}
]
}
임시 제한 유형 등록 요청¶
임시 제한 유형을 등록할 때 이 요청을 사용하세요. type_status 값을 N으로 설정하고 언어별 제목과 사유 내용을 함께 전달하세요.
{
"appid": "com.com2us.hivesdk.normal.freefull.apple.global.ios.universal",
"type_status": "N",
"type_name": "임시 접속 제한(게임 데이터 수정)",
"type_en_name": "Temporary access restriction (game data modified)",
"reasons": [
{
"language": "ko",
"title": "게임 이용에 불편을 드려 죄송합니다.",
"reason": "현재 게임 데이터를 수정하는 중입니다. 빠른 조치를 위해 최선을 다하겠습니다."
},
{
"language": "en",
"title": "We apologize for any inconvenience you may have experienced.",
"reason": "We are currently modifying the game data. We will try our best to resolve the issue as soon as possible."
},
{
"language": "ja",
"title": "ご利用中にご不便をおかけし、大変申し訳ございません。",
"reason": "只今ゲームデータを修正しています。迅速な解決に向けて最善を尽くします。"
}
]
}
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 |
| data | 결과 데이터 | Object |
| data.block_type | 등록된 이용 정지 유형 번호 | Integer |
응답 코드¶
| 코드값 | 설명 |
|---|---|
| 0 | 성공 |
| 2499 | JWT 검증 실패 (token_validation 참고) |
| 4000 | 유효하지 않은 파라미터 |
| 4014 | 이용 정지 팝업 형식 불일치 |
| 4015 | 이용 정지 필수 등록 언어 누락 (한국어, 영어) |
| 4016 | 이용 정지 유형 데이터 byte 제한 초과 |
| 6000 | 유효하지 않은 appid |
Response example¶
성공¶
{
"result_code": 0,
"result_msg": "SUCCESS",
"token_validation": {
"result_code": 0,
"result_msg": "success"
},
"data": {
"block_type": 88
}
}
이용 정지 유형 해제¶
등록된 이용 정지 유형을 Hive 서버에서 삭제합니다. 현재 이용 정지 중인 사용자 데이터가 존재하는 유형은 삭제할 수 없습니다.
Request URL¶
| 상용 URL | https://auth.qpyou.cn/v2/game/block/type/delete |
|---|---|
| Sandbox URL | https://sandbox-auth.qpyou.cn/v2/game/block/type/delete |
| HTTP Method | POST |
| Content-Type | application/json |
| Data Format | JSON |
Request header¶
| 필드명 | 설명 | 타입 | 필수여부 |
|---|---|---|---|
| X-Access-Token | 앱 서버 인증을 위한 OAuth 2.0 Access Token (OAuth Token 발급하기 참고) | String | Y |
| ISCRYPT | 데이터 암호화 여부 (0 = 암호화 안 함) (무조건 0으로 전달) | Integer | Y |
Request body¶
| 필드명 | 설명 | 타입 | 필수여부 |
|---|---|---|---|
| appid | App ID | String | Y |
| block_type | 이용 정지 유형 번호 | Integer | Y |
Request example¶
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 | 미등록 유형 |
| 4012 | 등록된 이용 정지 사용자 데이터 존재 |
| 6000 | 유효하지 않은 appid |
Response example¶
성공¶
{
"result_code": 0,
"result_msg": "SUCCESS",
"token_validation": {
"result_code": 0,
"result_msg": "success"
}
}
Note
JWT 검증 실패 시, token_validation 필드로 상세한 에러 정보를 확인할 수 있습니다. 자세한 내용은 JWT 검증 에러 코드를 참고하세요.