특정 유저 킥 API 제작 가이드

개요

여러 요구사항으로 인해 게임에 접속 중인 특정 유저의 접속을 강제 종료(킥) 하기 위한 API 제작 가이드 입니다.

킥 요청을 받는 경우 해당 유저가 접속 중일 때 접속을 종료 하시면 됩니다.

• 접속중이지 않은 유저의 킥 요청이 전달 될 수 있습니다.

게임 접속 종료 요청

Endpoint

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

서버 요청 인증보안

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

Request Body

필드	타입	필수여부	설명	예시
imId	String(50)	Y	IMID	LMY5FY9H3U6KB3RAWVRS

요청 샘플

{
    "imId": "LMY5FY9H3U6KB3RAWVRS"
}

Response

정보

킥 성공/실패 여부는 게임의 특성에 따라 다를 수 있으니, 상세한 성공/실패의 상태를 가이드에 추가 부탁 드립니다.

• 예시
  • 접속 여부와 상관 없이 성공을 반환한다.
  • 비 접속중인 유저는 실패는 반환한다.
  • 성공을 반환 하였으나 유저가 로비로 이동 할 때 까지는 게임에 접속 해 있을 수 있다.
  • 최대 5분 내 접속이 종료 된다.

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

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

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

리턴코드 정의 샘플

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

성공 샘플

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

실패 샘플

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

{
    "resultCode": "INVALID_USER",
    "resultMessage": "no account"
}