kakao developers

iOS

This document describes what you should do to integrate the Kakao SDK for iOS (hereinafter referred to as 'iOS SDK') into your web before leveraging the Kakao APIs.

Features

The iOS SDK has the following features:

• Uses Swift.
• Implements intuitive interface similar with the usability of REST API.
• Adopts networking and JSON libraries such as Retrofit, and Alamofire to maximize performance.
• Provides ReactvieX Extension that makes your code reactive and helps you to program more effectively when you use RxSwift.
• Adopts a default browser (CustomTabs) instead of WebView to enhance security.

Requirements

Here are what you need to use the iOS SDK:

• Xcode 11.0 or higher
• iOS 11.0 or higher
• iOS Deployment Target 11.0 or higher
• Swift 5.0 or higher

External library dependency

The iOS SDK uses the following libraries that are automatically installed when installing the iOS SDK:

• iOS SDK: Alamofire
• ReactiveX iOS SDK: RxSwift, RxCocoa, RxAlamofire

Install SDK

You can install the Kakao SDK either by:

• Using CocoaPods
• Using Swift Package Manager (SPM)

Using CocoaPods

1. Install or update CocoaPods to the latest version. CocoaPods 1.8 or higher is required.
2. Add the entire modules of the Kakao SDK or the desired modules in the Podfile in your project as below. If you add all modules, you must complete the Cocoapods settings for picker.
3. In Terminal, go to your project's root folder and run pod install.
4. Open .xcworkspace file to work on your project.

# Add all modules
pod 'KakaoSDK'

# or

# Add the desired modules
pod 'KakaoSDKCommon'  # Common module that contains essential elements
pod 'KakaoSDKAuth'  # Authentication
pod 'KakaoSDKUser'  # Kakao Login, User
pod 'KakaoSDKTalk'  # Kakao Talk Social, Kakao Talk messaging
pod 'KakaoSDKFriend' # Friend picker, 'Cocoapods settings for picker' is required.
pod 'KakaoSDKStory'  # Kakao Story
pod 'KakaoSDKShare'  # Kakao Talk sharing
pod 'KakaoSDKTemplate'  # Message default template
pod 'KakaoSDKNavi'  # Kakao Navi

# Add all modules
pod 'RxKakaoSDK'

# or

# Add the desired modules
pod 'RxKakaoSDKCommon'  # Common module that contains essential elements
pod 'RxKakaoSDKAuth'  # Authentication
pod 'RxKakaoSDKUser'  # Kakao Login, User
pod 'RxKakaoSDKTalk'  # Kakao Talk Social, Kakao Talk messaging
pod 'RxKakaoSDKFriend' # Friend picker, 'Cocoapods settings for picker' is required.
pod 'RxKakaoSDKStory'  # Kakao Story
pod 'RxKakaoSDKShare'  # Kakao Talk sharing

Module dependency

Some modules in the Kakao SDK are dependent on another module. If you add the Common or Auth module, its subordinate modules are automatically added together.

Cocoapods settings for picker

If you want to implement the Friend picker or add all modules including the Friend picker, you must add the KakaoSDKFriend or RxKakaoSDKFriend modules. These modules include the built binary framework unlike other modules, you must add the following code snippet at the bottom of your Podfile. Afterthat, run pod install to apply the changes.

post_install do |installer|
  installer.pods_project.targets.each do |target|
      target.build_configurations.each do |config|
        config.build_settings['BUILD_LIBRARY_FOR_DISTRIBUTION'] = 'YES'
      end
  end
end

Using Swift Package Manager

In iOS SDK 2.8.5 or higher, you can simply install the iOS SDK by using Swift Package Manager (SPM). The SPM is a tool used to manage the distribution of source code and built in Xcode 11 or higher. For more details, refer to Adding Package Dependencies to Your App.

In your Xcode,

1. Select [File] > [Add Packages] > [Add Swift Packages].
   If the menu is not displayed, go to your project in [PROJECT] > [Package Dependencies] and click [+] under 'Packages'.
2. Input the GitHub repository URL of the iOS SDK you want to add in the Search box:
   - iOS SDK: https://github.com/kakao/kakao-ios-sdk.git
   - ReactiveX iOS SDK: https://github.com/kakao/kakao-ios-sdk-rx
3. After selecting the 'kakao-ios-sdk' or 'kakao-ios-sdk-rx' package, set the version, branch, or commit hash in 'Dependency Rule'. If you specify the version, the minimum version should be 2.8.5 or higher. Then, click [Add package].
4. Choose the packages that you want to use, and then click [Add package].

To check if libraries are successfully added, select your project in [TARGETS], and then check if the libraries you selected are listed under 'Frameworks, Libraries, and Embedded Content'.

Configure build settings

Since iOS 9.0, iOS only allows apps registered in Allowlist to enhance security. Thus, you must register 'Allowlist' to allow your app to run Kakao apps, such as Kakao Talk, Kakao Story, Kakao Navi, and so on.

To register Allowlist:

1. Add the LSApplicationQueriesSchemes key with an array type in the plist file.
2. Add the Items to the LSApplicationQueriesSchemes key, and set them to "kakaokompassauth" and "kakaolink".

You need to set 'URL Schemes' to use the Custom URL Scheme. The Custom URL Scheme is used to run an app through a Kakao Talk message or Kakao Story post, or to go back to your app after logging in through Kakao Talk or Kakao Account.

1. Go to [Info] > [URL Type] > [URL Schemes].
2. Input your Native app key in kakao${YOUR_NATIVE_APP_KEY} format. For example, if your Native app key is 123456789, set 'URL Schemes' to "kakao123456789".

This setting above is used to create the Custom URL Scheme in the following format.

• Kakao Login: kakao${NATIVE_APP_KEY}://oauth
• Kakao Talk Sharing: kakao${NATIVE_APP_KEY}://kakaolink
• Kakao Story: kakao${NATIVE_APP_KEY}://kakaostory

Or you can add the keys manaully in the Info.plst file as follows:

<key>KAKAO_APP_KEY</key>
<string>0123456789abcdefghijklmn</string>


<key>LSApplicationQueriesSchemes</key>
<array>
    <string>kakao${YOUR_NATIVE_APP_KEY}</string>
    <string>kakaokompassauth</string>
    <string>storykompassauth</string>
    <string>kakaolink</string>
    <string>storylink</string>
</array>

Initialize SDK

After installing the SDK, you need to initialize the SDK for the initial setup.

To initialize the iOS SDK,

1. Add the following import statement in AppDelegate.swift.
2. Initialize the KakaoSDK instance by adding the initSDK method with your Native app key in the application method of AppDelegate instance.
   If you use SwiftUI App Life Cycle, add initSDK() inside the ${PROJECT_NAME}App class created with the SwiftUI App project, instead of AppDelegate.swift.

import KakaoSDKCommon

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {

  ...
  KakaoSDK.initSDK(appKey: "NATIVE_APP_KEY")
  ...

}

import RxKakaoSDKCommon

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {

  ...
  RxKakaoSDK.initSDK(appKey: "NATIVE_APP_KEY")
  ...

}

import SwiftUI
import KakaoSDKCommon
import KakaoSDKAuth
...

@main
struct SwiftUI_testApp: App {

    ...
    init() {
        // Initialize Kakao SDK.
        KakaoSDK.initSDK(appKey: "NATIVE_APP_KEY")
    }
    ...

}

Migrate v1 to v2

You can migrate the Legacy iOS SDK (version 1.x.x) to the latest version of iOS SDK (version 2.x.x) using this migration guide.

Initialization

The Legacy iOS SDK requires you to configure a project and import the SDK, and then call APIs. On the other hand, the latest iOS SDK requires explicit initialization, so you must have your app launched and initialized first and then call an API.

Notice when using token-based APIs

The token-based APIs refer to the APIs that require Kakao Login with which you can get an access token.

With the Legacy iOS SDK, you need to use KOSessionTask to call an API that passes an access token issued through Kakao Login. When using the Legacy iOS SDK, the session changes according to a user's login status, and some APIs can be called only when a session is open.

APIs in the latest iOS SDK are separated by modules so that you can use the desired modules only. However, for the API that passes an access token through Kakao Login, you must install the Kakao Login module along with the desired module and implement the login function.

Considering the structural difference, you must check if the module you want to use is dependent on Kakao Login. For the token-based APIs that require Kakao Login, the development guide for each API describes the required modules and whether to implement Kakao Login.

API comparison by version

Common

• Latest SDK: Call the initSDK() method that initializes the SDK through KakaoSDK.

Kakao Login

• Legacy SDK:
  • Call the Kakao Login APIs including the Getting consent to desired term API through KOSession.
  • Call the token-based APIs such as including the Retrieving shipping address and the Retrieving user agreed terms APIs through KOSessionTask.
• Latest SDK:
  • Call the Kakao Login APIs through UserApi in the KakaoSDKUser module.
  • Call the Checking token presence API through AuthApi in the KakaoSDKAuth module.

Kakao Talk Social

• Legacy SDK: Call the Kakao Talk Social APIs through KOSessionTask.
• Latest SDK: Call the Kakao Talk Social APIs through TalkApi in the KakaoSDKTalk module.

Message: Kakao Talk Sharing

• Legacy SDK:
  • Call the Kakao Talk sharing APIs through KLKTalkLinkCenter for Sending message API.
  • Call the Image API through KLKImageStorage.
  • If Kakao Talk is not installed on a user's device, a message is internally sent through a WebView.
• Latest SDK:
  • Call the Kakao Talk sharing APIs through ShareApi in the KakaoSDKShare module.
  • If Kakao Talk is not installed on a user's device, implement a process to share URI through a WebView or a default browser.

Message: Kakao Talk Messaging

• Legacy SDK: Call the Kakao Talk APIs through KOSessionTask.
• Latest SDK: Call the Kakao Talk APIs through TalkApi in the KakaoSDKTalk module.

Kakao Story

• Legacy SDK: Call the Kakao Story APIs through KOSessionTask.
• Latest SDK: Call the Kakao Story APIs through StoryApi in the KakaoSDKStory module.

Kakao Talk Channel

• Legacy SDK:
  • Call the Adding Kakao Talk Channel and Kakao Talk Channel chat APIs through KPFPlusFriend.
  • Call the Checking Kakao Talk Channel relationship API through KOSessionTask.
• Latest SDK:
  • Call the Kakao Talk Channel APIs through TalkApi in the KakaoSDKTalk module.
  • Call the Checking Kakao Talk Channel relationship API after implementing Kakao Login.

Kakao Navi

• Legacy SDK:
  • Call the Navi APIs through KNVNaviLauncher.
  • Use a class builder to set parameters.
• Latest SDK:
  • Call the Navi APIs through KakaoSDKNavi in the NaviApi module.
  • Define the constructor for each class to set parameters.

Push Notification

• Legacy SDK: Call the Push Notification API through KOSessionTask.
• Latest SDK: Not support Push Notification API. You can send the push notifications only using REST API.

See more

• Download iOS SDK
• API Reference for iOS →
• API Reference for ReactiveX iOS →

Legacy

To see how to use the Legacy Kakao SDK for iOS, see Getting Started Guide for Legacy iOS SDK.

It is highly recommended to migrate to the new version of iOS SDK as soon as possible because the Legacy version may not be supported anymore.