iNavi Maps 경로 탐색 API Reference

Restful API 기반 경로 탐색 API 를 사용하는 방법을 설명 합니다.

iNavi Maps API 를 사용하기 위해서는 Appkey 발급이 필요합니다.
Toast 사이트에서 ‘Maps’ 상품을 신청하여 AppKey 발급을 받으면 iNavi Maps API 를 사용 하실 수 있습니다.

자세한 사항은 Toast Maps 상품안내 를 참고해주세요.

일반 경로 탐색 직접 해보기

출발지와 목적지 (경유지 옵션) 좌표를 이용하여 탐색된 상세 정보와 경로 정보를 반환합니다.

  • Request URL

    Http Method URL
    GET, POST https://api-maps.cloud.toast.com/maps/v3.0/appkeys/{appkey}/route-normal
  • Request Path Parameter

    타입 설명
    appKey String 고유의 appKey
  • Request Parameters

    타입 필수 설명
    startX String O 출발지 X좌표
    startY String O 출발지 Y좌표
    endX String O 목적지 X좌표
    endY String O 목적지 Y좌표
    option String O 경로탐색 옵션
    • 탐색 option 하나만 가능
    • ex) option=real_traffic
    • real_traffic : 실시간 추천1
    • real_traffic2 : 실시간 추천2
    • real_traffic_freeroad : 실시간 (무료)
    • short_distance_priority : 단거리
    • motorcycle : 이륜차
    coordType String O 좌표 타입
    • tw : 팅크웨어 좌표
    • wgs84
    via1X String X 경유지1 X좌표
    via1Y String X 경유지1 Y좌표
    via2X String X 경유지2 X좌표
    via2Y String X 경유지2 Y좌표
    via3X String X 경유지3 X좌표
    via3Y String X 경유지3 Y좌표
    via4X String X 경유지4 X좌표
    via4Y String X 경유지4 Y좌표
    via5X String X 경유지5 X좌표
    via5Y String X 경유지5 Y좌표
    useAngle Boolean X 출발 지점의 주행 방향 옵션
    • Default : false
    • false : 주행 방향 비우선
    • true: 주행 방향 우선 (angle 값 입력 필요)
    angle String X 각도
    • Default : 0
    • useAngle 이 true 일 때만 동작, 0 ˚~ 359 ˚ 까지 사용 가능
    carType Integer X 톨게이트비 계산을 위한 차종
    • Default : 1
    • ex) carType=1
    • 1 : 1종 (소형차)
    • 2 : 2종 (중형차)
    • 3 : 3종 (대형차)
    • 4 : 4종 (대형화물차)
    • 5 : 5종 (특수화물차)
    • 6 : 경차 (통행료할인적용)
    guideTop Integer X 표출할 안내 정보 개수
    groupByTrafficColor Boolean X 세부경로목록 (paths) 정보를 교통색상별로 그룹핑하여 반환할지 여부
  • Response Field

    타입 설명
    header (Object) isSuccessful Boolean 성공여부
    resultCode Integer 실패 코드
    resultMessage String 실패 메시지
    route (Object) data (Object) 경로 정보 option String 탐색 옵션
    spend_time Integer 소요 시간(초)
    distance Integer 거리(m)
    toll_fee Integer 톨게이트 요금
    paths (Array) 세부 경로 목록 coords (Array) 상세 좌표 목록 x Double X좌표
    • (coordType에 따라 tw 또는 wgs84 좌표로 반환가능)
    y Double Y좌표
    • (coordType에 따라 tw 또는 wgs84 좌표로 반환가능)
    speed Integer 속도(km)
    spend_time Integer 소요 시간(초)
    distance Integer 거리(m)
    road_code Integer 도로 종별 코드
    traffic_color String 도로 교통 색상

일반 경로 탐색 요약 직접 해보기

출발지와 목적지(경유지 옵션) 좌표를 이용하여 탐색된 요약 정보(거리, 시간, 탐색옵션) 정보를 반환합니다.

  • Request URL

    Http Method URL
    GET, POST https://api-maps.cloud.toast.com/maps/v3.0/appkeys/{appkey}/route-summary
  • Request Path Parameter

    타입 설명
    appKey String 고유의 appKey
  • Request Parameters

    타입 필수 설명
    startX String O 출발지 X좌표
    startY String O 출발지 Y좌표
    endX String O 목적지 X좌표
    endY String O 목적지 Y좌표
    coordType String O 좌표 타입
    • tw : 팅크웨어 좌표
    • wgs84
    option String O 경로탐색 옵션
    • 탐색 option "," 단위로 요청
    • ex) option=real_traffic,real_traffic2
    • real_traffic : 실시간 추천1
    • real_traffic2 : 실시간 추천2
    • real_traffic_freeroad : 실시간 (무료)
    • short_distance_priority : 단거리
    • motorcycle : 이륜차
    via1X String X 경유지1 X좌표
    via1Y String X 경유지1 Y좌표
    via2X String X 경유지2 X좌표
    via2Y String X 경유지2 Y좌표
    via3X String X 경유지3 X좌표
    via3Y String X 경유지3 Y좌표
    via4X String X 경유지4 X좌표
    via4Y String X 경유지4 Y좌표
    via5X String X 경유지5 X좌표
    via5Y String X 경유지5 Y좌표
  • Response Field

    타입 설명
    header (Object) isSuccessful Boolean 성공여부
    resultCode Integer 실패 코드
    resultMessage String 실패 메시지
    route (Object) data (Array) 경로 정보 option String 옵션명
    spend_time Integer 소요시간(초)
    distance Integer 거리(m)

다중 출발지 경로 탐색 요약 직접 해보기

하나 이상의 다중 출발지 좌표와 하나의 목적지 좌표를 탐색하여 각각의 시간과 거리 정보를 반환합니다.

  • Request URL

    Http Method URL
    POST https://api-maps.cloud.toast.com/maps/v3.0/appkeys/{appkey}/route-start-multi-summary
  • Request Path Parameter

    타입 설명
    appKey String 고유의 appKey
  • Request Parameters

    타입 필수 설명
    data (Array)
    • 출발지 정보
    startIdx String O 출발지 식별 ID
    startX String O 출발지 X좌표
    startY String O 출발지 Y좌표
    orderby String O 정렬 기준
    • 0 : distance_desc : 거리 내림차순
    • 1 : distance_asc : 거리 오름차순
    • 2 : time_desc : 시간 내림차순
    • 3 : time_asc : 시간 오름차순
    coordType String O 좌표 타입
    • tw : 팅크웨어 좌표
    • wgs84
    endX String O 목적지 X좌표
    endY String O 목적지 Y좌표
    resultCount Integer X 응답요청 개수
  • Response Field

    타입 설명
    header (Object) isSuccessful Boolean 성공여부
    resultCode Integer 실패 코드
    resultMessage String 실패 메시지
    route (Object) data (Array) 경로 정보 spend_time Integer 소요시간(초)
    distance Integer 거리(m)
    startX String 출발지 X좌표
    startY String 출발지 Y좌표
    startIdx String 출발지 식별 ID

다중 목적지 경로 탐색 요약 직접 해보기

하나의 출발지 좌표와 하나 이상의 다중 목적지 좌표를 탐색하여 각각의 시간과 거리 정보를 반환합니다.

  • Request URL

    Http Method URL
    POST https://api-maps.cloud.toast.com/maps/v3.0/appkeys/{appkey}/route-end-multi-summary
  • Request Path Parameter

    타입 설명
    appKey String 고유의 appKey
  • Request Parameters

    타입 필수 설명
    data (Array)
    • 목적지 정보
    endIdx String O 목적지 식별 ID
    endX String O 목적지 X좌표
    endY String O 목적지 Y좌표
    orderby String O 정렬 기준
    • 0 : distance_desc : 거리 내림차순
    • 1 : distance_asc : 거리 오름차순
    • 2 : time_desc : 시간 내림차순
    • 3 : time_asc : 시간 오름차순
    coordType String O 좌표 타입
    • tw : 팅크웨어 좌표
    • wgs84
    startX String O 출발지 X좌표
    startY String O 출발지 Y좌표
    resultCount Integer X 응답요청 개수
  • Response Field

    타입 설명
    header (Object) isSuccessful Boolean 성공여부
    resultCode Integer 실패 코드
    resultMessage String 실패 메시지
    route (Object) data (Array) 경로 정보 spend_time Integer 소요 시간(초)
    distance Integer 거리(m)
    endIdx String 목적지 식별 ID
    endX String 목적지 X좌표
    endY String 목적지 Y좌표

일반 경로 예측 탐색 직접 해보기

출발, 도착 예정시간을 기준으로 예측 도착시간 및 출발지와 목적지 (경유지 옵션) 좌표를 이용하여 탐색된 상세 정보와 경로 정보를 반환합니다.

  • Request URL

    Http Method URL
    GET https://api-maps.cloud.toast.com/maps/v3.0/appkeys/{appkey}/route-time
  • Request Path Parameter

    타입 설명
    appKey String 고유의 appKey
  • Request Parameters

    타입 필수 설명
    startX String O 출발지 X좌표
    startY String O 출발지 Y좌표
    endX String O 목적지 X좌표
    endY String O 목적지 Y좌표
    type String O 기준시간(출발,도착)
    year Integer O 기준년(ex.2019)
    month Integer O 기준월
    day Integer O 기준일
    hour Integer O 기준시간(시)
    minutes Integer O 기준시간(분)
    via1X String X 경유지1 X좌표
    via1Y String X 경유지1 Y좌표
    via2X String X 경유지2 X좌표
    via2Y String X 경유지2 Y좌표
    via3X String X 경유지3 X좌표
    via3Y String X 경유지3 Y좌표
    via4X String X 경유지4 X좌표
    via4Y String X 경유지4 Y좌표
    via5X String X 경유지5 X좌표
    via5Y String X 경유지5 Y좌표
    coordType String X 좌표 타입
    • Default : wgs84
    • tw : 팅크웨어 좌표
    • wgs84
    carType Integer X 톨게이트비 계산을 위한 차종
    • Default : 1
    • ex) carType=1
    • 1 : 1종(소형차)
    • 2 : 2종(중형차)
    • 3 : 3종(대형차)
    • 4 : 4종(대형화물차)
    • 5 : 5종(특수화물차)
    • 6 : 경차(통행료할인적용)
    useTrafficColor Boolean X 도로 교통 색상 반환 유무(true, false)
    guideTop Integer X 표출할 안내 정보 개수
    groupByTrafficColor Boolean X 세부경로목록 (paths) 정보를 교통색상별로 그룹핑하여 반환할지 여부
    beforeCount Integer X 기준 시간 이전전시간 탐색 개수
    afterCount Integer X 기준 시간 이후시간 탐색 개수
    interval Integer X 기준 시간 이전/이후 시간 Interval(분)
  • Response Field

    타입 설명
    header (Object) isSuccessful Boolean 성공 여부
    resultCode Integer 실패 코드
    resultMessage String 실패 메시지
    route (Object) data (Object) 경로 정보 file_name String 경로 주변 POI 검색을 위한 binary 파일명
    option String 탐색 옵션
    spend_time Integer 소요 시간(초)
    distance Integer 거리(m)
    toll_fee Integer 톨게이트 요금
    times (Array) 세부 경로 목록 index Integer 기준시간 대비 Index(0 이면 기준시간)
    spend_time Integer 소요시간(초)
    start_time (Object) 출발시간 year Object
    month Object
    day Object
    hour Object
    minutes Object
    end_time (Object) 도착시간 year Object
    month Object
    day Object
    hour Object
    minutes Object
    paths (Array) 세부 경로 목록 coords (Array) 상세 좌표 목록 x Double X좌표
    y Double Y좌표
    speed Integer 속도
    spend_time Integer 소요시간(초)
    distance Integer 거리(m)
    road_code Integer 도로 종별 코드
    traffic_color String 도로 교통 색상
    guides (Array) 주요 도로 정보 목록 coords (Array) 상세 좌표 목록 x Array X좌표
    y Array Y좌표
    distance Integer 거리(m)
    name String 도로명
    road_code Integer 도로 종별 코드
    score Integer 비중
    speed Integer 속도(km)
    type String 도로 타입
    traffic_color String 도로 교통 색상

결과코드

결과 코드값 리스트

  • 결과코드

    resultCode resultMessage 비고 설명
    0 공통 성공
    100 Result Not Found 검색전용 결과없음
    101 Argument Error 공통 파라미터 오류
    102 Internal Server Error 검색전용 서버 오류
    201 Searching for Security 검색전용 POI 보안시설물
    202 Longitude/Latitude 검색전용 경위도
    203 Mobile Phone Number 검색전용 전화번호(Mobile)
    204 Invalid Query 검색전용 서버 오류
    205 POI not in given Admin 검색전용 결과없음(지역설정)
    206 POI not in given Area 검색전용 결과없음(영역설정)
    207 POI not in given Category 검색전용 결과없음(분류설정)
    208 Neighbor Search Only 검색전용 결과없음(주변검색만입력)
    209 Neighbor Search not Found 검색전용 결과없음(주변 + 키워드 검색 결과 없음)
    300 AppKey Error 공통 AppKey 인증 오류

×
Data(Array) :
Request Parameters
Response
Result