Kakao Developers

Auth

Description:

카카오 로그인 API 모듈
Module for Kakao Login APIs

Methods

(static) authorize(settings)

Description:

카카오 로그인 간편로그인
Login for Kakao Login

See:

데모 보러가기

Parameters:

Name Type Description

settings

Object

Properties

Name	Type	Attributes	Default	Description
`redirectUri`	String	<optional>		인가 코드를 전달받을 서비스 서버의 URI URI of the service server to get the authorization code
`state`	String	<optional>		카카오 로그인 과정 중 동일한 값을 유지하는 임의의 문자열 (정해진 형식 없음) A string that keeps the same value during the Kakao Login process (No fixed format)
`scope`	String	<optional>		사용자에게 동의 요청할 동의항목 ID 목록, 쉼표로 구분된 문자열 Scope IDs to request for user's consent, a comma-seperated string
`prompt`	String	<optional>		동의 화면에 상호작용 추가 요청 프롬프트 Prompt to add an interaction to the consent screen `login`: 사용자 재인증, Reauthenticate user `none`: 카카오톡에서 자동 로그인, Auto-login `create`: 카카오계정 가입 후 로그인, Login after signing up for a Kakao Account `select_account`: 카카오계정 간편로그인, Kakao Account easy login
`loginHint`	String	<optional>		카카오계정 로그인 페이지의 ID란에 자동 입력할 값 A value to fill in the ID field of the Kakao Account login page
`nonce`	String	<optional>		ID 토큰 재생 공격 방지를 위한 검증 값, 임의의 문자열 Random strings to prevent replay attacks
`throughTalk`	Boolean	<optional>	`true`	간편로그인 사용 여부 Whether to use simple login

(static) cleanup()

Description:

사용한 카카오 로그인 모듈 리소스 해제
Cleans up used Kakao Login module resources

(static) getAccessToken() → {String}

Description:

Kakao SDK에 할당된 액세스 토큰 값 반환
Returns the access token set in the Kakao SDK

Returns:

Type: String

(static) getAppKey() → {String}

Description:

Kakao SDK 초기화 시 사용된 앱 키 반환
Returns the app key used to initialize the Kakao SDK

Returns:

Type: String

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

Description:

현재 사용자의 카카오 로그인 상태 반환
Returns the current user's Kakao login status

Returns:

Type: Promise.<(StatusResponse|AuthError)>

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

Description:

로그아웃
Logout

See:

데모 보러가기

Returns:

Type: Promise.<(LogoutResponse|AuthError)>

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

Description:

배송지 선택하기
Select shipping address

Parameters:

Name Type Description

settings

Object

Properties

Name	Type	Attributes	Default	Description
`forceMobileLayout`	Boolean	<optional>	`false`	모바일 레이아웃으로 고정 여부 Whether to fix the layout for mobile
`enableBackButton`	Boolean	<optional>	`true`	뒤로가기 버튼 활성화 여부 Whether to enable the back button

Returns:

Type: Promise.<(ShippingAddressResponse|ShippingAddressError)>

(static) setAccessToken(token, persistopt)

Description:

토큰 할당하기
Set tokens

Parameters:

Name	Type	Attributes	Default	Description
`token`	String			액세스 토큰 Access token
`persist`	Boolean	<optional>	`true`	새로고침을 하더라도 액세스 토큰을 사용할 수 있도록 `sessionStorage`에 저장할지 여부 Whether to save in the `sessionStorage` to use the access token regardless refreshing

Type Definitions

AuthError

Description:

인증 및 인가 에러
Authorization or authentication errors

Properties:

Name Type Description

error

Object

Properties

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

인증 및 인가 에러
Authorization or authentication errors

Type:

Object

LogoutResponse

Description:

로그아웃 응답
Response of logout

Properties:

Name Type Description

userInfo

Object

Properties

Name	Type	Description
`id`	Number	회원번호 Service user ID

로그아웃 응답
Response of logout

Type:

Object

ShippingAddressError

Description:

배송지 에러
Errors for shipping address

Properties:

Name Type Description

error

Object

Properties

Name	Type	Description
`error_code`	String	에러 코드 Error code
`error_msg`	String	에러 메시지 Error message
`status`	String	요청 결과, `error` 로 고정 Request result, fixed as `error`

배송지 에러
Errors for shipping address

Type:

Object

ShippingAddressResponse

Description:

배송지 정보
Response for a shipping address

Properties:

Name Type Description

response

Object

Properties

Name	Type	Description
`address_id`	Number	배송지 ID Shipping address ID
`status`	String	요청 결과, `success`로 고정 Request result, fixed as `success`

배송지 정보
Response for a shipping address

Type:

Object

StatusResponse

Description:

사용자의 카카오 로그인 상태
Kakao login status of the user

Properties:

Name Type Description

statusInfo

Object

Properties

Name	Type	Description
`status`	String	로그인 상태 (`connected`: 로그인 상태 \| `not_connected`: 비로그인 상태) Login status (`connected`: Logged in \| `not_connected`: Not logged in)
`user`	Object	로그인한 사용자의 정보 Logged in user information

사용자의 카카오 로그인 상태
Kakao login status of the user

Type:

Object