유저 탈퇴 갱신 API 제작 가이드

개요

IM Assemble 플랫폼 계정이 삭제(탈퇴/서비스철회) 될 때 게임 서버에 요청 정보를 전달 하기 위한 API 입니다.

일반적으로 제재 처리 요청을 받으시면 현재 접속 중인 유저를 게임에서 접속 해제 하는 것을 권장 합니다.

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

계정 삭제(탈퇴/서비스철회) 요청

Endpoint

  • method

    • POST

  • Content-Type

    • application/json

서버 요청 인증보안

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

Request Body

필드
타입
필수여부
설명
예시

imId

String(50)

Y

IMID

LMY5FY9H3U6KB3RAWVRS

요청 샘플

{
    "imId": "LMY5FY9H3U6KB3RAWVRS"
}

계정 삭제(탈퇴/서비스철회) 취소

Endpoint

  • method

    • POST

  • Content-Type

    • application/json

서버 요청 인증보안

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

Request Body

필드
타입
필수여부
설명
예시

imId

String(50)

Y

IMID

LMY5FY9H3U6KB3RAWVRS

요청 샘플

{
    "imId": "LMY5FY9H3U6KB3RAWVRS"
}

Response

응답은 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"
}

Last updated