Kakaomobility Developers

다크 모드

시작하기 전에 ​

앱 등록 및 REST API 키 확인하기 ​

길찾기 API를 사용하기 위해서는 애플리케이션(이하 앱)을 등록하고 REST API 키를 발급 받아야 합니다.

1. 앱 등록하기 ​

[카카오디벨로퍼스에서 진행]

  1. 카카오디벨로퍼스에 로그인하세요. 계정이 없을 경우, 회원 가입을 한 후 다음 단계를 진행하세요.

  2. 로그인 후, 화면 오른쪽 상단에서 앱 → 앱 생성를 클릭하세요.

  3. 아래 각 항목에 추가할 내용을 확인하여 앱을 추가하세요.


  • 앱 아이콘: 앱 아이콘으로 사용할 이미지를 추가합니다. 권장하는 이미지의 사이즈는 128 px * 128 px이며 최대 250 KB 크기의 파일을 등록할 수 있습니다. 지원하는 파일 포맷은 JPG, GIF, PNG입니다.

  • 앱 이름: 내 앱(서비스)의 이름을 설정합니다. * 필수 입력 사항

  • 회사명: 사업자명을 입력합니다. 사업자 정보와 동일한 이름을 사용해야 합니다. * 필수 입력 사항

DANGER

주의: 앱(서비스) 이름은 공백 포함 30자까지 입력할 수 있습니다.

  • 카테고리: 서비스의 카테고리를 선택합니다. * 필수 입력 사항

  • 앱 대표 도메인: 서비스의 대표 도메인을 입력합니다.

  1. 각 항목을 입력하고, 운영 정책에서 제한하는 사항에 해당하지 않은지 확인 후, 저장을 눌러 앱을 생성하세요. 생성된 앱은 앱에서 확인할 수 있습니다.

2. 서비스 정보 등록하기 ​

[카카오디벨로퍼스에서 진행]

REST API 호출에는 REST API 키가 필요하며, 사용 전 서비스 정보를 카카오디벨로퍼스에 등록해야 합니다.

  1. 앱 → 앱 키를 발급할 앱 선택 → 앱 → 플랫폼 키을 클릭하세요.

  2. REST API 키 추가 또는 생성된 기본 키를 선택하세요.

  3. 필요한 서비스 정보 항목을 등록하세요.

  • REST API 키: 발급된 REST API 키 값을 확인하고 복사할 수 있습니다.
  • 키 이름: 키를 식별하기 위한 이름을 지정합니다. * 필수 입력 사항
  • 호출 허용 IP 주소: REST API 키로 요청을 허용할 IP 주소를 등록합니다.
  • 리다이렉트 URI: 카카오 로그인 또는 비즈니스 인증 사용 시 필요한 리다이렉트 URI를 등록합니다.
  • 클라이언트 시크릿: 사용 여부를 설정하고 코드를 발급·관리합니다. REST API 키는 생성 시 기본적으로 클라이언트 시크릿이 활성화됩니다.
  • 추가 정보: 키의 활성화 상태와 생성일, 수정일 정보를 확인할 수 있습니다.

TIP

자세한 내용은 카카오디벨로퍼스의 앱 설정을 참고하세요.

3. REST API 키 확인하기 ​

[카카오디벨로퍼스에서 진행]

  1. 앱 → 앱 키를 발급할 앱 선택 → 앱 → 플랫폼 키을 클릭하세요.
  2. REST API 키 값을 복사하여 사용하세요.

길찾기 API 제공 정보 ​

각각의 API별로 설정할 수 있는 장소 개수와 제공 정보는 다음과 같습니다.

표 1 길찾기 API 제공 정보
API 이름출발지목적지경유지출발 기준
시간		제공되는 정보
자동차 길찾기1개1개최대 5개현재구간별 경로 상세 안내 정보 또는 경로 요약 정보
다중 경유지 길찾기1개1개최대 30개현재구간별 경로 상세 안내 정보 또는 경로 요약 정보
다중 출발지 길찾기1개 이상
(최대 30개)		1개-현재예상 소요 시간, 이동 거리
다중 목적지 길찾기1개1개 이상
(최대 30개)		-현재예상 소요 시간, 이동 거리
미래 운행 정보 길찾기1개1개최대 5개미래구간별 경로 상세 안내 정보 또는 경로 요약 정보

길찾기 API 사용에 대한 쿼터와 가격을 확인할 수 있습니다. 각 API에 대한 쿼터 상향이 필요하거나 위의 표에서 언급한 최대 장소 개수를 초과하여 설정할 경우 제휴 문의로 문의하세요.

길찾기 API 목록 ​

길찾기 API에서 제공하는 기능과 기본적인 요청 규격 정보는 아래와 같습니다.

표 2 길찾기 API
NameURLHostMethod
자동차 길찾기/v1/directionshttps://apis-navi.kakaomobility.comGET
다중 경유지 길찾기/v1/waypoints/directionshttps://apis-navi.kakaomobility.comPOST
다중 출발지 길찾기/v1/origins/directionshttps://apis-navi.kakaomobility.comPOST
다중 목적지 길찾기/v1/destinations/directionshttps://apis-navi.kakaomobility.comPOST
미래 운행 정보 길찾기/v1/future/directionshttps://apis-navi.kakaomobility.comGET