게임 이용 정지 사용자 확인하기¶

커뮤니티, 웹페이지 등에서 웹 로그인을 시도할 때 앱 진입이 차단된 사용자를 확인하는 API입니다.

Request URL¶

상용 URL	https://auth.qpyou.cn/v2/game/block/get
Sandbox URL	https://sandbox-auth.qpyou.cn/v2/game/block/get
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
player_id	Player ID	Integer	Y
language	언어 값입니다. 입력하지 않으면 영어로 설정됩니다. ko (한국어) en (영어) ja (일본어) zh-hans (중국어 간체) zh-hant (중국어 번체) de (독일어) fr (프랑스어) ru (러시아어) es (스페인어) pt (포르투갈어) id (인도네시아어) th (태국어) vi (베트남어) it (이탈리아어) tr (터키어) ar (아랍어) tl (필리핀어)	String	N

Request example¶

{
  "appid": "com.com2us.hivesdk.normal.freefull.apple.global.ios.universal",
  "player_id": 20000020208,
  "language": "ko"
}

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.is_blocked	이용 정지 여부 `true`: 이용 정지 사용자 `false`: 정상 사용자	Boolean
data.status	이용 정지 상태 `N`: 정상 사용자 `P`: 영구 이용 정지 사용자 `B`: 이용 정지 기간이 있는 이용 정지 사용자	String
data.start_date	이용 정지 시작일	String
data.end_date	이용 정지 종료일	String
data.remaining_date	이용 정지 남은 일수 (`language` 해당 언어로 표기, 기본값: 영어)	String
data.reason	이용 정지 사유 (`language` 해당 언어로 표기, 기본값: 영어)	String

응답 코드¶

코드값	설명
0	성공
2499	JWT 검증 실패 (token_validation 참고)
4000	유효하지 않은 파라미터
6000	유효하지 않은 appid

Response example¶

성공 (정상 사용자)¶

{
  "result_code": 0,
  "result_msg": "SUCCESS",
  "token_validation": {
    "result_code": 0,
    "result_msg": "success"
  },
  "data": {
    "is_blocked": false,
    "status": "N",
    "start_date": null,
    "end_date": null,
    "remaining_date": null,
    "reason": null
  }
}

성공 (이용 정지 기간이 있는 이용 정지 사용자)¶

{
  "result_code": 0,
  "result_msg": "SUCCESS",
  "token_validation": {
    "result_code": 0,
    "result_msg": "success"
  },
  "data": {
    "is_blocked": true,
    "status": "B",
    "start_date": "2024-05-15 10:00:00",
    "end_date": "2024-06-30 23:59:59",
    "remaining_date": "27d 5hr 8min",
    "reason": "Temporary Restriction (Retrieve game money)"
  }
}

성공 (영구 이용 정지 사용자)¶

{
  "result_code": 0,
  "result_msg": "SUCCESS",
  "token_validation": {
    "result_code": 0,
    "result_msg": "success"
  },
  "data": {
    "is_blocked": true,
    "status": "P",
    "start_date": "2024-05-15 10:00:00",
    "end_date": "9999-12-31 00:00:00",
    "remaining_date": "Permanent",
    "reason": "Temporary Restriction (Retrieve game money)"
  }
}

JWT 검증 실패¶

{
    "result_code": 2499,
    "result_msg": "JWT validation failed. See token_validation for details.",
    "token_validation": {
        "result_code": 2408,
        "result_msg": "The access token is expired. Please refresh your token."
    }
}

실패¶

{
  "result_code": 4000,
  "result_msg": "Request has invalid format.",
  "token_validation": {
    "result_code": 0,
    "result_msg": "success"
  },
  "data": "player_id"
}

Note

JWT 검증 실패 시, token_validation 필드로 자세한 오류 정보를 확인할 수 있습니다. 자세한 내용은 JWT 검증 에러 코드를 참고하세요.