유저 제재 정보 갱신 API 제작 가이드

개요

유저의 제재 정보가 갱신 되었을 때 게임 서버에 알려줍니다.

제재 처벌, 기간 갱신, 해제 되는 시점에 해당 API를 호출하여 게임 알리며, 게임 서버에서 후속 조치가 필요한 경우 해당 API에서 구현 하시면 됩니다.

정보

ban.md 기능을 연동 시에만 유효 합니다.

본 가이드는 표준 가이드이므로 게임에 맞게 변경하여 API 연동 가이드와 함께 제공 해 주시면 됩니다.

• 제재 정보는 login verify 와 get user info 에서 전달 중이기 때문에 별도 저장을 권장하지 않습니다.
• 유저가 접속해 있는 경우 제재 변경 사항에 대한 즉시 적용을 처리해 주시면 됩니다.

제재 설정

Endpoint

• method
  • POST
• Content-Type
  • application/json

서버 요청 인증보안

• 요청 서버에 대한 인증을 위해 시크릿 키를 헤더에 설정 할 수 있습니다.

Request Body

필드	타입	필수여부	설명	예시
imId	String(50)	Y	IMID	LMY5FY9H3U6KB3RAWVRS
blockId	Int	Y	제재ID	1
reasonId	Int	Y	사유ID	101
blockedAt	Long	Y	제재 적용 시간 unix 타임스탬프 millisecond	1722513692729
expireAt	Long	Y	제재 만료 시간 unix 타임스탬프 miilisecond	1722513692729
permanent	Boolean	Y	영구 제재 유무	false
metadata	String	N	게임 제재 정보 게임에서 GMTool 등으로 처벌이 진행 될 때 전달 한 정보 플랫폼제재는 공백

요청 샘플

{
    "imId": "LMY5FY9H3U6KB3RAWVRS",
    "blockId": 1,
    "reasonId": 101,
    "blockedAt": 1722513692729,
    "expireAt": 1722513692729,
    "permanent": false,
    "metadata": ""
}

제재 해제

Endpoint

• method
  • POST
• Content-Type
  • application/json

서버 요청 인증보안

• 요청 서버에 대한 인증을 위해 시크릿 키를 헤더에 설정 할 수 있습니다.

Request Body

필드	타입	필수여부	설명	예시
imId	String(50)	Y	IMID	LMY5FY9H3U6KB3RAWVRS
blockId	Int	Y	제재ID	1

요청 샘플

{
    "imId": "LMY5FY9H3U6KB3RAWVRS",
    "blockId": 1
}

Response

응답은 JSON 형태로 전달 됩니다.

• Content-Type: application/json;charset=UTF-8

필드	타입	설명
resultCode	String	리턴 코드(아래 코드 정의 참고)
resultMessage	String	에러 상세 내용

리턴코드 정의 샘플

코드	비고
SUCCESS	성공
INVALID_PARAMETER	잘못된 파라미터로 API요청 시스템에서의 요청 파라미터가 잘못된 경우
INVALID_USER	잘못된 게임 유저
NOT_ALLOW_AUTH	API 사용 권한이 없는 경우 - 인증 정보가 잘못

성공 샘플

{
    "resultCode": "SUCCESS",
    "resultMessage": "request success"
}

오류 샘플

• 처리 오류의 경우 HTTP 상태코드는 200
• 오류 코드와 메세지를 정의하여 전달

{
    "resultCode": "INVALID_PARAMETER",
    "resultMessage": "Not allowed block id"
}