AuthApi

final public class AuthApi

카카오 로그인의 주요 기능을 제공하는 클래스입니다.

이 클래스를 이용하여 카카오톡 간편로그인 또는 카카오계정 로그인 으로 로그인을 수행할 수 있습니다.

카카오톡 간편로그인 예제입니다.

// 로그인 버튼 클릭
if (AuthApi.isKakaoTalkLoginAvailable()) {
    AuthApi.shared.loginWithKakaoTalk()
}

// AppDelegate
func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
    if (AuthController.isKakaoTalkLoginUrl(url)) {
        if AuthController.handleOpenUrl(url: url, options: options) {
            return true
        }
    }
    ...
}

카카오계정 로그인 예제입니다.

AuthApi.shared.loginWithKakaoAccount()

카카오 로그인 인증서버로 API 요청을 담당하는 클래스입니다.

  • 간편하게 API를 호출할 수 있도록 제공되는 공용 싱글톤 객체입니다.

    Declaration

    Swift

    public static let shared: AuthApi
  • 카카오톡 간편로그인이 실행 가능한지 확인합니다.

    내부적으로 UIApplication.shared.canOpenURL() 메소드를 사용합니다. 카카오톡 간편로그인을 위한 커스텀 스킴은 kakaokompassauth이며 이 메소드를 정상적으로 사용하기 위해서는 LSApplicationQueriesSchemes에 해당 스킴이 등록되어야 합니다. 등록되지 않은 상태로 메소드를 호출하면 카카오톡이 설치되어 있더라도 항상 false를 반환합니다.

    // info.plist
    <key>LSApplicationQueriesSchemes</key>
    <array>
      <string>kakaokompassauth</string>
    </array>
    

    Declaration

    Swift

    public static func isKakaoTalkLoginAvailable() -> Bool
  • 카카오톡 으로부터 리다이렉트 된 URL 인지 체크합니다.

    Declaration

    Swift

    public static func isKakaoTalkLoginUrl(_ url: URL) -> Bool
  • 사용자가 앞서 로그인을 통해 토큰을 발급 받은 상태인지 확인합니다. 주의: 기존 토큰 존재 여부를 확인하는 기능으로, 사용자가 현재도 로그인 상태임을 보장하지 않습니다.

    Declaration

    Swift

    public static func hasToken() -> Bool
  • 카카오톡 간편로그인을 실행합니다.

    Note

    AuthApi.isKakaoTalkLoginAvailable() 메소드로 실행 가능한 상태인지 확인이 필요합니다. 카카오톡을 실행할 수 없을 경우 loginWithKakaoAccount() 메소드로 웹 로그인을 시도할 수 있습니다.

    Declaration

    Swift

    public func loginWithKakaoTalk(channelPublicIds: [String]? = nil,
                                   serviceTerms: [String]? = nil,
                                   completion: @escaping (OAuthToken?, Error?) -> Void)
  • iOS 11 이상에서 제공되는 (SF/ASWeb)AuthenticationSession 을 이용하여 로그인 페이지를 띄우고 쿠키 기반 로그인을 수행합니다. 이미 사파리에에서 로그인하여 카카오계정의 쿠키가 있다면 이를 활용하여 ID/PW 입력 없이 간편하게 로그인할 수 있습니다.

    Declaration

    Swift

    public func loginWithKakaoAccount(prompts : [Prompt]? = nil, completion: @escaping (OAuthToken?, Error?) -> Void)
  • 사용자로부터 카카오가 보유중인 사용자 정보 제공에 대한 동의를 받습니다.

    카카오로부터 사용자의 정보를 제공 받거나 카카오서비스 접근권한이 필요한 경우, 사용자로부터 해당 정보 제공에 대한 동의를 받지 않았다면 이 메소드를 사용하여 추가 항목 동의를 받아야 합니다. 필요한 동의항목과 매칭되는 scope id를 배열에 담아 파라미터로 전달해야 합니다. 동의항목과 scope id는 카카오 디벨로퍼스의 [내 애플리케이션] > [제품 설정] > [카카오 로그인] > [동의항목]에서 확인할 수 있습니다.

    사용자 동의 획득 시나리오

    간편로그인 또는 웹 로그인을 수행하면 최초 로그인 시 카카오 디벨로퍼스에 설정된 동의항목 설정에 따라 사용자의 동의를 받습니다. 동의항목을 설정해도 상황에 따라 동의를 받지 못할 수 있습니다. 대표적인 케이스는 아래와 같습니다.

    • 선택 동의 로 설정된 동의항목이 최초 로그인시 선택받지 못한 경우
    • 필수 동의 로 설정하였지만 해당 정보가 로그인 시점에 존재하지 않아 카카오에서 동의항목을 보여주지 못한 경우
    • 사용자가 해당 동의항목이 설정되기 이전에 로그인한 경우

    이외에도 다양한 여건에 따라 동의받지 못한 항목이 발생할 수 있습니다.

    추가 항목 동의 받기 시 주의사항

    선택 동의 으로 설정된 동의항목에 대한 추가 항목 동의 받기는, 반드시 사용자가 동의를 거부하더라도 서비스 이용이 지장이 없는 시나리오에서 요청해야 합니다.

    Declaration

    Swift

    public func loginWithKakaoAccount(scopes:[String],
                                      completion: @escaping (OAuthToken?, Error?) -> Void)
  • 사용자 인증코드를 이용하여 신규 토큰 발급을 요청합니다.

    Declaration

    Swift

    public func token(code: String,
                      codeVerifier: String? = nil,
                      redirectUri: String = KakaoSDKCommon.shared.redirectUri(),
                      completion:@escaping (OAuthToken?, Error?) -> Void)
  • 기존 토큰을 갱신합니다.

    Declaration

    Swift

    public func refreshAccessToken(refreshToken: String? = nil,
                                   completion:@escaping (OAuthToken?, Error?) -> Void)