Kakao Developers

Auth

Description:

사용자 인증과 관련된 함수들이 포함되어 있습니다.

Methods

(static) authorize(settings)

Description:

사용자가 앱에 로그인할 수 있도록 인가 코드를 요청하는 함수입니다. 인가 코드를 받을 수 있는 서버 개발이 필요합니다.

See:

데모 보러가기

Parameters:

Name Type Description

settings

Object

인가 코드 요청과 관련된 설정을 key/value로 전달합니다.

Properties

Name	Type	Attributes	Default	Description
`redirectUri`	String	<optional>		인가 코드를 받을 URI
`state`	String	<optional>		인가 코드 요청과 응답 과정에서 유지할 수 있는 파라미터
`scope`	String	<optional>		추가 동의 받을 항목의 키 ex) "account_email,gender" OpenID Connect 확장 기능 사용 시, 추가 동의 받을 항목의 키와 "openid"를 함께 전달해야 함
`prompt`	String	<optional>		동의 화면 요청 시 추가 상호작용을 요청할 때 사용 "login": 기존 사용자 인증 여부와 상관없이 사용자에게 카카오계정 로그인 화면을 출력하여 다시 사용자 인증을 수행하고자 할 때 사용 "create": 사용자가 카카오계정 신규 가입 후 로그인하도록 할 때 사용 "select_account": 카카오계정 간편 로그인을 요청할 때 사용
`loginHint`	String	<optional>		로그인 힌트 주기 요청 시 사용 카카오계정 로그인 페이지의 ID란에 자동 입력할 값
`nonce`	String	<optional>		OpenID Connect를 통해 ID 토큰을 함께 발급받을 경우, ID 토큰 재생 공격을 방지하기 위해 사용
`throughTalk`	Boolean	<optional>	`true`	간편 로그인 사용 여부

(static) cleanup()

Description:

로그인 버튼을 생성하기 위해 삽입한 iframe을 삭제하고 리소스를 해제합니다.

(static) getAccessToken() → {String}

Returns:

사용 중인 액세스 토큰

Type: String

(static) getAppKey() → {String}

Returns:

사용 중인 앱 키

Type: String

(static) getStatusInfo() → {Promise.<(StatusResponse|AuthError)>}

Description:

현재 로그인 상태를 반환합니다.

Returns:

Type: Promise.<(StatusResponse|AuthError)>

(static) logout() → {Promise.<(LogoutResponse|AuthError)>}

Description:

현재 로그인되어 있는 사용자를 로그아웃시키고, 액세스 토큰을 삭제합니다.

See:

데모 보러가기

Returns:

Type: Promise.<(LogoutResponse|AuthError)>

(static) selectShippingAddress(settings) → {Promise.<(ShippingAddressResponse|ShippingAddressError)>}

Description:

배송지를 선택하여 배송지 ID를 얻을 때 사용합니다.

Parameters:

Name Type Description

settings

Object

배송지 선택하기와 관련된 설정을 key/value로 전달합니다.

Properties

Name	Type	Attributes	Default	Description
`forceMobileLayout`	Boolean	<optional>	`false`	배송지 피커를 모바일 디바이스에 맞춘 레이아웃으로 고정할 것인지 지정
`enableBackButton`	Boolean	<optional>	`true`	배송지 피커의 뒤로 가기 버튼 노출 여부 지정

Returns:

Type: Promise.<(ShippingAddressResponse|ShippingAddressError)>

(static) setAccessToken(token, persistopt)

Description:

API 호출 시 사용할 액세스 토큰을 설정합니다.

Parameters:

Name	Type	Attributes	Default	Description
`token`	String			사용할 액세스 토큰
`persist`	Boolean	<optional>	`true`	새로고침을 하더라도 액세스 토큰을 사용할 수 있도록 `sessionStorage` 저장 여부

Type Definitions

AuthError

Properties:

Name Type Description

error

Object

Properties

Name	Type	Description
`code`	Number	에러 코드
`msg`	String	에러 메시지

LogoutResponse

Properties:

Name Type Description

userInfo

Object

Properties

Name	Type	Description
`id`	Number	회원번호

ShippingAddressError

Properties:

Name Type Description

error

Object

Properties

Name	Type	Description
`error_code`	String	에러 코드
`error_msg`	String	에러 메시지
`status`	String	배송지 요청 결과, `"error"`

ShippingAddressResponse

Properties:

Name Type Description

response

Object

Properties

Name	Type	Description
`address_id`	Number	배송지 ID
`status`	String	배송지 요청 결과, `"success"`

StatusResponse

Properties:

Name Type Description

statusInfo

Object

Properties

Name	Type	Description
`status`	String	"connected" 또는 "not_connected"
`user`	Object	로그인 상태일 때만 전달되는 사용자 정보