Getting started

This document guides how to use the Kakao SDK for Android("Android SDK") provided by the Kakao API platform.

Modules

The modules and main features of Android SDK are below.

Module dependency

Some modules in the Kakao SDK are dependent on another module. Each subordinate module is automatically added together.

Before you begin

Requirements

• Android Studio 3.6.1 or higher
• API 23: Android 6.0 (Marshmallow) or higher

Note: 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)

Platform

Set Android app information on [My Application] > [Platform]. Refer to Platform.

Key hashes

Key hashes are the values hashed from the certificate fingerprints of the certificate and used to check if the app is malicious and the updates or changes are from the original app. The API server checks if the key hash added to the 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 running or debugging.
• Release key hash is generated from a Release certificate to release the app to the store.

Check the key hashes in one of the ways below. Register all of the key hashes in [My Application] > [Platform] > [Android]. Refer to Platforms.

Using Terminal to generate Debug and Release key hashes

To get key hashes using Terminal, Keytool program, key and certificate management tool are required. On Windows, download OpenSSL for Windows libraries is required. On Mac, Keytool is installed.

Run the command in Command Prompt according to the operating system.

Debug 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

Release key hash

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

Using Kakao SDK to get Debug and Release key hashes

Call the getKeyHash() method provided in Utility through the Android SDK.

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

var keyHash = Utility.getKeyHash(this)

Using the Google Play Console to get Release key hash

With Google Play App Signing, use the SHA-1 certificate fingerprint obtained on the Google Play Console, not generating a Release key hash on the Terminal. Refer to Play Console Help > Use Play App Signing for more details.

In the Google Play Console, select [Release Management] > [App Signing], and then copy the value of SHA-1 certificate fingerprint. Refer to Use Play App Signing.

keytool -printcert -file ./deployment_cert.der 

Run the following command in Terminal with the SHA-1 certificate fingerprint value obtained.

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

Project settings

Internet permission

Allow internet permission to communicate with the Kakao Sever through the Kakao APIs.

<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"
    ...

Java 8 features

To use the Java 8 features, add the following settings to the build.gradle.kts(module-level) file. Refer to the official site for Android app developers for more details.

// Use Java 8 features

android {

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

Optional: ProGuard rules

To enable shrinking, obfuscation, and optimization when building the release version of the app, add the following codes 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.**

Install

Set Gradle

Set Gradle by declaring a Maven repository to sync the project with the Android SDK. Depending on the version of Android Studio, the file to declare repositories is different. Refer to Dependency management in Gradle for more details.

settings.gradle.kts

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
        maven { url = java.net.URI("https://devrepo.kakao.com/nexus/content/groups/public/") }
    }
}

Add modules

To use the Kakao APIs, add the desired modules to the build.gradle.kts(module-level) file.

dependencies {
  implementation "com.kakao.sdk:v2-all:2.20.1" // Add all modules (Available in 2.11.0 or higher)
  implementation "com.kakao.sdk:v2-user:2.20.1" // Module for the Kakao Login APIs
  implementation "com.kakao.sdk:v2-share:2.20.1" // Module for the Kakao Talk Sharing APIs
  implementation "com.kakao.sdk:v2-talk:2.20.1" // Module for the Kakao Talk Channel, Kakao Talk Social, Kakao Talk Message APIs
  implementation "com.kakao.sdk:v2-friend:2.20.1" // Module for the picker APIs
  implementation "com.kakao.sdk:v2-navi:2.20.1" // Module for the Kakao Navi APIs
  implementation "com.kakao.sdk:v2-cert:2.20.1" // Module for the Kakao Certification APIs
}

dependencies {
  implementation "com.kakao.sdk:v2-all-rx:2.20.1" // Add all modules (Available in 2.11.0 or higher)
  implementation "com.kakao.sdk:v2-user-rx:2.20.1" // Module for the Kakao Login APIs
  implementation "com.kakao.sdk:v2-share-rx:2.20.1" // Module for the Kakao Talk Sharing APIs
  implementation "com.kakao.sdk:v2-talk-rx:2.20.1" // Module for the Kakao Talk Channel, Kakao Talk Social, Kakao Talk Message APIs
  implementation "com.kakao.sdk:v2-friend-rx:2.20.1" // Module for the picker APIs
  implementation "com.kakao.sdk:v2-navi:2.20.1" // Module for the Kakao Navi APIs
  implementation "com.kakao.sdk:v2-cert:2.20.1" // Module for the Kakao Certification APIs
}

Initialize

After installing the SDK, 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}")
  }
}