콘텐츠로 이동

이용 정지 API 가이드

이용 정지 등록

개발사 운영 정책에 따라 Hive 서버에서 계정을 이용 정지 상태로 만드는 기능을 제공합니다. Hive 콘솔에서 이용 정지 유형을 사전에 등록하면, 영구 이용 정지 사용자와 기간 제한이 있는 이용 정지 사용자를 구분해 등록할 수 있습니다. 또 기존에 등록한 사용자(PlayerID로 구분) 이용 정지 유형과 이용 정지 기간을 변경할 수 있습니다.

Basics

Request URL
  • 상용: https://auth.qpyou.cn/game/block/set
  • 샌드박스: https://sandbox-auth.qpyou.cn/game/block/set
Method POST
HTTP Header
  • Content-type: application/json
  • ISCRYPT: 0
Response Format JSON

Request

Parameter Type Required Description
appid String O 앱 아이디
player_id Integer O 플레이어 아이디
hive_certification_key String O Hive 인증키(앱센터에서 발급)
status String O 이용 정지 상태
  • P: 영구 이용 정지
  • B: 이용 정지 기간이 있는 유저
block_type Integer O 이용 정지 유형 번호
[Hive 콘솔 > 인증 > 이용 정지 > 유형 등록]에서 먼저 등록해야 합니다.
start_date String O 이용 정지 시작일
end_date String O 이용 정지 종료일
skip_blocked Boolean X skip_blocked=true로 요청하면 기존 차단 데이터가 이미 있는 경우 차단 데이터를 변경하지 않고 result_code=0을 반환합니다.
did Integer X 게임 앱 설치 시 생성되는 게임 앱 식별자입니다. 동일한 종류의 게임 앱을 식별할 때 사용합니다. SDK 초기화 시 새로 발급되거나 이미 존재하는 값을 반환받아 전달하면 해당 기기의 로그인 이력을 검증합니다.

Response

Parameter Type Description
result_code Integer 결과 코드
  • 0: 정상
  • 4000: 유효하지 않은 파라미터
    • 이용 정지 시작일과 종료일의 형식이 올바르지 않은 경우
    • 시작일이 종료일보다 큰 경우
    • 현재 시간이 종료일보다 큰 경우
  • 4002: Hive 인증키 불일치
  • 4011: 미등록 유형
  • 4013: did 로그인 이력 검증 실패
    • 로그아웃 상태에서는 검증 불가
  • 6000: 유효하지 않은 appid
result_msg String 이용 제한 사유 결과 메시지

기간 제한 이용 정지 등록 요청 예시

기간 제한 이용 정지 사용자를 등록할 때는 statusB로 지정하고 start_date, end_date를 함께 전달하세요.

curl -X POST https://auth.qpyou.cn/game/block/set \
-H 'Content-Type: application/json' \
-H 'ISCRYPT: 0' \
-d '{"appid" : "com.com2us.hivesdk.normal.freefull.apple.global.ios.universal", "player_id" : 24000000000, "hive_certification_key" : "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJIaXZlIiwiaWF0IjoxNjAyMDU2NzI2LCJqdGkiOiIxODczMTExMzIwIn0.3soFiHTPlObCoqR5xX9ZeOQTSvnHrHDHWmopP3QfWtY", "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}'

기간 제한 이용 정지 등록 성공 응답 예시

요청이 정상 처리되면 result_code0이고 result_msgSUCCESS로 반환됩니다.

{
"result_code": 0,
"result_msg": "SUCCESS"
}

이용 정지 해제

특정 계정이 이용 정지된 상태를 Hive 서버에서 직접 해제합니다.

Basics

Request URL
  • 상용: https://auth.qpyou.cn/game/block/delete
  • 샌드박스: https://sandbox-auth.qpyou.cn/game/block/delete
Method POST
HTTP Header
  • Content-type: application/json
  • ISCRYPT: 0
Response Format JSON

Request

필드 타입 필수 여부 설명
appid String O 앱 아이디
player_id Integer O 플레이어 아이디
hive_certification_key String O Hive 인증키(앱센터에서 발급)

Response

필드 타입 설명
result_code Integer
  • 0: 정상
  • 2002: 이용 정지 미등록 유저
  • 4000: 유효하지 않은 파라미터
  • 4002: Hive 인증키 불일치
  • 6000: 유효하지 않은 appid
result_msg String 결과 메시지

이용 정지 해제 요청 예시

특정 계정의 이용 정지를 해제할 때는 아래 요청 형식으로 appid, player_id, hive_certification_key를 함께 전달하세요.

curl -X POST https://auth.qpyou.cn/game/block/delete \
-H 'Content-Type: application/json' \
-H 'ISCRYPT: 0' \
-d '{"appid" : "com.com2us.hivesdk.normal.freefull.apple.global.ios.universal", "player_id" : 24000000000, "hive_certification_key" : "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJIaXZlIiwiaWF0IjoxNjAyMDU2NzI2LCJqdGkiOiIxODczMTExMzIwIn0.3soFiHTPlObCoqR5xX9ZeOQTSvnHrHDHWmopP3QfWtY"}'

이용 정지 해제 성공 응답 예시

요청이 정상 처리되면 result_code0이고 result_msgSUCCESS로 반환됩니다.

{
    "result_code": 0,
    "result_msg": "SUCCESS"
}