카카오내비 api 예제 - kakaonaebi api yeje

Android

이 문서는 Kakao SDK for Android(이하 Android SDK)를 사용한 카카오내비 API 구현 방법을 소개합니다.

시작하기 전에

모듈 설정

카카오내비 API는 카카오내비 모듈의 NaviClient가 제공합니다. 카카오내비 모듈은 ReactiveX 버전을 따로 제공하지 않으므로, 사용 중인 카카오 SDK 버전에 관계없이 동일하게 설정합니다. 모듈 설정을 참고하여 build.gradle(Module) 파일에 카카오내비 모듈인 v2-navi를 추가합니다.

카카오내비 앱 설치 여부 확인

카카오내비 API는 길 안내의 navigateIntent()와 목적지 공유의 shareDestinationIntent() 두 가지 주요 기능을 제공합니다.

navigateIntent() 또는 shareDestinationIntent()는 카카오내비 앱으로 목적지 공유 및 길 안내 기능을 실행하는 Intent를 반환합니다. 카카오내비 앱이 설치되어 있을 경우에는 앱을 호출하고, 그렇지 않을 경우에는 기본 브라우저로 설치 페이지를 엽니다.

사용자 기기에 카카오내비 앱이 설치되어 있는지 확인하려면 isKakaoNaviInstalled() API를 사용합니다. 다음은 카카오내비 앱 실행 여부를 출력해보는 예제입니다.

if (NaviClient.instance.isKakaoNaviInstalled(context)) {
    Log.i(TAG, "카카오내비 앱으로 길 안내 가능")
} else {
    Log.i(TAG, "카카오내비 미설치")
}

파라미터 구성하기

카카오내비 API 호출 시 필요한 파라미터들은 목적지 정보인 Location과 검색 조건을 정의한 NaviOption 객체에 담아 전달합니다.

Location

특정 장소를 표현하는 Location 클래스는 다음과 같이 구성돼 있습니다.

NaviOption

길을 찾는 조건을 설정하는 NaviOption 클래스는 다음과 같이 구성돼 있습니다.

NaviOption의 모든 구성 요소는 선택적으로 지정 가능합니다. 하지만 중요한 구성 요소를 지정하지 않으면 카카오내비가 조건에 맞춰 장소와 길을 찾지 못하므로, 중요한 검색 조건들은 반드시 지정해야 합니다.

다음은 구성 요소별 클래스 정보입니다. Enum 클래스인 구성 요소는 지정된 값 중 하나만 사용할 수 있습니다.

Enum: CoordType

Enum: VehicleType

Enum: RpOption

길 안내하기

기본 정보

길 안내는 사용자의 현재 위치로부터 지정한 목적지까지의 경로를 카카오내비로 안내하는 기능입니다. NaviClient의 navigateIntent()를 호출해 Intent를 반환 받아 실행하도록 구현합니다.

navigateIntent() 호출 시 목적지 정보를 담은 Location, 검색 조건을 담은 NaviOption 객체를 전달해야 합니다. NaviOption에는 원하는 검색 조건만 지정하여 요청할 수 있습니다.

startX, startY, startAngle 파라미터를 사용해 경로 검색 시 참고할 출발 지점을 지정할 수 있습니다. 그러나 길 안내 시에는 사용자의 현재 위치로부터 목적지까지의 안내만을 제공하며, 별도의 출발 지점을 지정할 수는 없습니다.

다음은 길 안내 예제입니다.

// 카카오내비 앱으로 길 안내
if (NaviClient.instance.isKakaoNaviInstalled(requireContext())) {
    // 카카오내비 앱으로 길 안내 - WGS84
    startActivity(
        NaviClient.instance.navigateIntent(
            Location("카카오 판교오피스", "127.108640", "37.402111"),
            NaviOption(coordType = CoordType.WGS84)
        )
    )
} else {
    // 카카오내비 설치 페이지로 이동
    startActivity(
        Intent(
            Intent.ACTION_VIEW,
            Uri.parse(Constants.WEB_NAVI_INSTALL)
        ).addFlags(Intent.FLAG_ACTIVITY_NEW_TASK or Intent.FLAG_ACTIVITY_CLEAR_TOP)
    )
}

경유지 목록 설정이 가능합니다. 각 경유지 정보를 Location 객체에 담고, 요청 시 viaList 파라미터로 경유지 Location의 리스트(List)를 전달합니다.

if (NaviClient.instance.isKakaoNaviInstalled(requireContext())) {
    // 카카오내비 앱으로 길 안내 - WGS84 - 경유지 추가
    startActivity(
        NaviClient.instance.navigateIntent(
            Location("카카오 판교오피스", "127.108640", "37.402111"),
            NaviOption(coordType = CoordType.WGS84),
            // 경유지 목록 설정
            listOf(
                Location("판교역 1번출구", "127.111492", "37.395225")
            )
        )
    )
} else {
    // 카카오내비 설치 페이지로 이동
    startActivity(
        Intent(
            Intent.ACTION_VIEW,
            Uri.parse(Constants.WEB_NAVI_INSTALL)
        ).addFlags(Intent.FLAG_ACTIVITY_NEW_TASK or Intent.FLAG_ACTIVITY_CLEAR_TOP)
    )
}

다음은 카카오내비 실행 후 길 안내를 시작한 화면입니다.

웹 길 안내 제공 종료

Android SDK 2.8.4부터 카카오내비 앱 미설치 시 웹에서 길 안내를 실행하는 기능을 더 이상 제공하지 않습니다. 카카오내비 앱이 설치돼 있지 않은 경우에는 설치 페이지로 이동합니다. 이전 버전에서 제공하는 웹 길 안내 기능 또한 추후 제공 종료될 예정이므로, 최신 버전 업데이트를 권장합니다.

목적지 공유하기

기본 정보

목적지 공유하기는 카카오내비에서 지정한 목적지 정보를 공유할 수 있는 화면을 보여주는 기능입니다. NaviClient의 shareDestinationIntent()를 호출해 Intent를 반환 받아 실행하도록 구현합니다.

shareDestinationIntent() 호출 시 목적지 정보를 담은 Location, 검색 조건을 담은 NaviOption 객체를 전달해야 합니다. NaviOption에는 원하는 검색 조건만 지정하여 요청할 수 있습니다.

startX, startY, startAngle 파라미터를 사용해 경로 검색 시 참고할 출발 지점을 지정할 수 있습니다. 그러나 길 안내 시에는 사용자의 현재 위치로부터 목적지까지의 안내만을 제공하며, 별도의 출발 지점을 지정할 수는 없습니다.

다음은 목적지 공유하기 예제입니다.

if (NaviClient.instance.isKakaoNaviInstalled(requireContext())) {
    // 카카오내비 앱으로 목적지 공유하기 - WGS84
    startActivity(
        NaviClient.instance.shareDestinationIntent(
            Location("카카오 판교오피스", "127.108640", "37.402111"),
            NaviOption(coordType = CoordType.WGS84)
        )
    )
} else {
    // 카카오내비 설치 페이지로 이동
    startActivity(
        Intent(
            Intent.ACTION_VIEW,
            Uri.parse(Constants.WEB_NAVI_INSTALL)
        ).addFlags(Intent.FLAG_ACTIVITY_NEW_TASK or Intent.FLAG_ACTIVITY_CLEAR_TOP)
    )
}

경유지 목록 설정이 가능합니다. 각 경유지 정보를 Location 객체에 담고, 요청 시 viaList 파라미터로 경유지 Location의 리스트(List)를 전달합니다.

// 카카오내비 앱으로 목적지 공유하기 - 경유지 추가
if (NaviClient.instance.isKakaoNaviInstalled(requireContext())) {
    // 카카오내비 앱으로 목적지 공유하기 - WGS84
    startActivity(
        NaviClient.instance.shareDestinationIntent(
            Location("카카오 판교오피스", "127.108640", "37.402111"),
            NaviOption(coordType = CoordType.WGS84),
            // 경유지 목록 설정
            listOf(
                Location("판교역 1번출구", "127.111492", "37.395225")
            )
        )
    )
} else {
    // 카카오내비 설치 페이지로 이동
    startActivity(
        Intent(
            Intent.ACTION_VIEW,
            Uri.parse(Constants.WEB_NAVI_INSTALL)
        ).addFlags(Intent.FLAG_ACTIVITY_NEW_TASK or Intent.FLAG_ACTIVITY_CLEAR_TOP)
    )
}

다음은 카카오내비에서 목적지 공유하기를 실행한 화면입니다.

Legacy

카카오내비의 Legacy Kakao SDK for Android(이하 Legacy Android SDK) 개발 가이드는 아래 바로가기에서 확인할 수 있습니다. 추후 Legacy Android SDK에 대한 지원이 중단될 수 있으므로, 가급적 빠른 시일 내에 최신 버전 Android SDK로 변경할 것을 권장합니다.

더보기