kakao developers

Android

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

Features

The Android SDK has the following features:

• Uses Kotlin.
• Has intuitive interface similar to the usability of REST API.
• Adopts networking and JSON libraries such as Gson to maximize performance.
• Provides ReactvieX Extension that makes your code reactive and helps you to program more effectively when you use RxJava or RxKotlin.
• Adopts a default browser (AuthenticationSession) instead of WebView to enhance security.

Requirements

Here are what you need to use the Android SDK:

• Android Studio 3.6.1 or higher
• API 21: Android 5.0 (Lollipop) or higher

External library dependency

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

• Android SDK: Gson, Retrofit, OkHttp
• ReactiveX Android SDK: RxJava3 + Android SDK (Gson, Retrofit, OkHttp)

Install and configure SDK

You can install the Android SDK in your project. To do so,

1. Set Gradle.
2. Add modules.
3. Grant Internet permission.

Set Gradle

You need to set Gradle by declaring a Maven repository to sync your project with the Android SDK. Depending on the version of Android Studio, how you declare repositories is different.

If you use Android Studio Arctic Fox, declare the Maven repository in dependencyResolutionManagement in the project-level settings.gradle file. For more information, refer to Centralizing repositories declaration.

//If you use Android Studio Arctic Fox, add this block in settings.gradle.
dependencyResolutionManagement {    
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)    
        repositories {        
            google()        
            mavenCentral()        
            maven { url 'https://devrepo.kakao.com/nexus/content/groups/public/' }    
    }
}

If you use an earlier version of Android Studio Arctic Fox, declare the Maven repository in allprojects in the project-level build.gradle file.

// NOTE: You cannot declare repositories through 'allprojects' in Android Studio Arctic Fox.
allprojects {    
    repositories {        
        google()        
        jcenter()        
        maven { url 'https://devrepo.kakao.com/nexus/content/groups/public/'}    
    }
}

Add modules

To use the Kakao APIs, add the desired modules to the module-level build.gradle file according to the APIs you want to use.

dependencies {
  implementation "com.kakao.sdk:v2-all:2.13.0" // Add all modules (Available in 2.11.0 or higher)

  implementation "com.kakao.sdk:v2-user:2.13.0" // Kakao Login
  implementation "com.kakao.sdk:v2-talk:2.13.0" // Kakao Talk Social, Kakao Talk messaging
  implementation "com.kakao.sdk:v2-friend:2.13.0" // Friend picker
  implementation "com.kakao.sdk:v2-story:2.13.0" // Kakao Story
  implementation "com.kakao.sdk:v2-share:2.13.0" // Kakao Talk sharing
  implementation "com.kakao.sdk:v2-navi:2.13.0" // Kakao Navi 
}

dependencies {
  implementation "com.kakao.sdk:v2-all-rx:2.13.0" // Add all modules (Available in 2.11.0 or higher)

  implementation "com.kakao.sdk:v2-user-rx:2.13.0" // Kakao Login
  implementation "com.kakao.sdk:v2-talk-rx:2.13.0" // Kakao Talk Social, Kakao Talk messaging
  implementation "com.kakao.sdk:v2-friend-rx:2.13.0" // Friend picker
  implementation "com.kakao.sdk:v2-story-rx:2.13.0" // Kakao Story
  implementation "com.kakao.sdk:v2-share-rx:2.13.0" // Kakao Talk sharing
  implementation "com.kakao.sdk:v2-navi:2.13.0" // Kakao Navi 
}

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.

Grant Internet permission

To communicate with the Kakao Sever through the Kakao APIs, allow the internet permission.

<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.example.sample">
 
    <!-- Allow Internet permission -->
    <uses-permission android:name="android.permission.INTERNET" />

    <application
    android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
    ...

Enable Java 8 features

To use the Java 8 features, the following code snippet must be included in your project. If not, add the following to the module-level build.gradle file. For more details, refer to the official site for Android app developers.

// Use Java 8 features

android {

    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
    // For Kotlin projects
    kotlinOptions {
        jvmTarget = "1.8"
    }
}

Optional: Configure for shrinking and obfuscation

If you enable shrinking, obfuscation, and optimization when buiding the release version of your app, add the following -keep lines in the ProGuard rules file to exclude the Kakao SDK from shrinking and obfuscation.

-keep class com.kakao.sdk.**.model.* { <fields>; }
-keep class * extends com.google.gson.TypeAdapter

# https://github.com/square/okhttp/pull/6792
-dontwarn org.bouncycastle.jsse.**
-dontwarn org.conscrypt.*
-dontwarn org.openjsse.**

Initialize SDK

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

Initialize the KakaoSDK instance by adding the init method in the Application instance with your Native app key.

class GlobalApplication : Application() {
  override fun onCreate() {
    super.onCreate()
    // Other codes for initialization 

    // Initialize Android SDK 
    KakaoSdk.init(this, "${YOUR_NATIVE_APP_KEY}")
  }
}

Add key hashes

Key hashes are the values hashed from the certificate fingerprints of the certificate and used to check if your app is malicious and the updates or changes are from your original app. When you call the Kakao APIs, the API server checks if the key hash added to your request matches the value specified in [My Application] > [Platform] for identification. Key hash has two types:

• Debug key hash: is generated from a Debug certificate that is automatically generated from Android Studio when you run or debug your project.
• Release key hash: is generated from a Release certificate that you have created to release your app to the store. If you use Google Play App Signing, obtain a Release certificate from the app signing page in the Play Console.

Use one of methods to get a debug key hash and a release key hash.

keytool -exportcert -alias androiddebugkey -keystore ~/.android/debug.keystore -storepass android -keypass android | openssl sha1 -binary | openssl base64

keytool -exportcert -alias androiddebugkey -keystore %USERPROFILE%\.android\debug.keystore -storepass android -keypass android | openssl sha1 -binary | openssl base64

keytool -exportcert -alias <RELEASE_KEY_ALIAS> -keystore <RELEASE_KEY_PATH> | openssl sha1 -binary | openssl base64

keytool -exportcert -alias <RELEASE_KEY_ALIAS> -keystore <RELEASE_KEY_PATH> | openssl sha1 -binary | PATH_TO_OPENSSL_LIBRARY\bin\openssl base64

import com.kakao.sdk.common.util.Utility

var keyHash = Utility.getKeyHash(this)

keytool -printcert -file ./deployment_cert.der 

echo "{SHA-1_CERTIFICATE_FINGERPRINT}" | xxd -r -p | openssl base64 

When you get key hashes, go to [My Application] > [Platform] > [Android platform registration], and register all of your key hashes in 'Key hash'. Refer to Register platforms for more details.

Migrate v1 to v2

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

Module structure

The latest Android SDK has a simpler module structure compared to the Legacy Android SDK. The latest Android SDK provides the common module that contains the common and utility features and the Kakao Login function. In addition, each module provides APIs that are grouped by service under Client, and object and structure information is located in Model, which allows you to use the Android SDK more efficiently and conveniently.

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. To use the token-based APIs in the latest Android SDK, you must implement Kakao Login that the common module provides. When you add the desired modules, the common module is installed by default.

API comparison by version

Common

• Legacy SDK:
  • Set an app key in AndroidManifest.xml.
  • Call a function that initializes SDK through KakaoSDK.
  • Call a function that gets a key hash through Utility in the com.kakao.util package.
• Latest SDK:
  • Call a function that initializes SDK by passing your Native app key through KakaoSDK.
  • Call a function that gets a key hash through Utility.

Kakao Login

• Legacy SDK:
  • Call the Login API through LoginActivity.
  • Call the Retrieving token information API through AuthService.
  • Call the Logout, Unlink, Retrieving user information, and Storing user information APIs through Session.
  • Call the Retrieving shipping address and the Retrieving user agreed terms APIs through UserManagement.
  • Call the Getting consent to desired term API through LoginActivity.
• Latest SDK:
  • Call the Kakao Login APIs through UserApiClient in the v2-user module, except for the Checking token presence API.
  • Call the Checking token presence API through AuthApiClient.

Kakao Talk Social

• Legacy SDK: Call the Kakao Talk Social APIs through KOSessionTask.
• Latest SDK: Call the Kakao Talk Social APIs through TalkApiClient in the v2-talk module.

Message: Kakao Talk Sharing

• Legacy SDK:
  • Call the Kakao Talk sharing APIs through KakaoLinkService.
  • 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 ShareClient in the v2-share module.
  • Pass context for the Sending message API.
  • 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 KakaoTalkService.
• Latest SDK: Call the Kakao Talk APIs through TalkApiClient in the v2-talk module.

Kakao Story

• Legacy SDK: Call the Kakao Story APIs through KakaoStoryService.
• Latest SDK: Call the Kakao Story APIs through StoryApiClient in the v2-story module.

Kakao Talk Channel

• Legacy SDK:
  • Call the Adding Kakao Talk Channel and Kakao Talk Channel chat APIs through PlusFriendService.
  • Call the Checking Kakao Talk Channel relationship API through KakaoTalkService.
• Latest SDK:
  • Call the Adding Kakao Talk Channel and Kakao Talk Channel chat APIs through TalkApiClient in the v2-talk module.
  • Call the Checking Kakao Talk Channel relationship API after implementing Kakao Login.

Kakao Navi

• Legacy SDK:
  • Call the Navi APIs through KakaoNaviService.
  • Call newBuilder() of each class and setNaviOptions() to set parameters.
• Latest SDK:
  • Call the Navi APIs through NaviClient in the v2-navi module.
  • Define the constructor for each class to set parameters.

Push Notification

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

See more

• Download Android SDK
• API Reference →

Legacy

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

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