Toast Maps Route API Reference

Restful API 기반 Toast Maps Route API를 사용하는 방법을 설명 합니다.
Toast Maps Route API를 사용하기 위해서는 appkey 발급이 필요합니다.
http://cloud.toast.com > Console > Maps 상품을 이용 해주세요.

자세한 사항은 Reference를 참고해주세요.
_

경로 탐색 요약

입력한 좌표들에 대한 경로 탐색 결과 요약 정보

  • Request URL

    Http Method URL
    GET https://api-maps.cloud.toast.com/maps/v1.0/appkeys/{appkey}/routes?startX={startX}&startY={startY}&endX={endX}&endY={endY}&viaCount={viaCount}&via1X={via1X}&via1Y={via1Y}&via2X={via2X}&via2Y={via2Y}&option={option}
  • Request Path parameter

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

    타입 필수 설명
    ​startX String O 출발지 X좌표
    ​startY String O 출발지 Y좌표
    ​endX String O 도착지 X좌표
    ​endY String O 도착지 Y좌표
    ​viaCount String X 경유지 개수
    ​via1X String X 경유지1 X좌표
    ​via1Y String X 경유지1 Y좌표
    ​via2X String X 경유지2 X좌표
    ​via2Y String X 경유지2 Y좌표
    ​option String O 경로탐색 옵션
    • 탐색 option "," 단위로 요청
    • ex) option=real_traffic,real_traffic2
    • freeroad_priority : 무료
    • highway_priority : 고속도로
    • real_traffic : 실시간
    • real_traffic_freeroad : 실시간 (무료)
    • real_traffic : 추천1
    • real_traffic2 : 추천2
    • rt_stats : 실시간통계
    • rt_stats_freeroad : 실시간통계(무료)
    • short_distance_priority : 단거리
    • stats : 통계
    • stats_freeroad : 통계(무료)
    • motorcycle : 이륜차
  • Response Json

    타입 설명
    header (Object) isSuccessful Boolean 성공여부
    resultCode Integer 실패 코드
    resultMessage String 실패 메시지
    route (Object) SummaryResult (Array) 0 String 옵션명
    1 Integer 경로 탐색 거리 (단위 : m)
    2 Integer 경로 탐색 시간 (단위 : 분)

경로 탐색 상세

입력한 좌표들에 대한 경로 탐색 결과 상세 정보

  • Request URL

    Http Method URL
    GET https://api-maps.cloud.toast.com/maps/v1.0/appkeys/{appkey}/route-details?startX={startX}&startY={startY}&endX={endX}&endY={endY}&viaCount={viaCount}&via1X={via1X}&via1Y={via1Y}&via2X={via2X}&via2Y={via2Y}&option={option}
  • Request Path parameter

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

    타입 필수 설명
    ​startX String O 출발지 X좌표
    ​startY String O 출발지 Y좌표
    ​endX String O 도착지 X좌표
    ​endY String O 도착지 Y좌표
    ​viaCount String X 경유지 개수
    ​via1X String X 경유지1 X좌표
    ​via1Y String X 경유지1 Y좌표
    ​via2X String X 경유지2 X좌표
    ​via2Y String X 경유지2 Y좌표
    ​option String O 경로탐색 옵션
    • 탐색 option 하나만 가능ex) option=real_traffic
    • freeroad_priority : 무료
    • highway_priority : 고속도로
    • real_traffic : 실시간
    • real_traffic_freeroad : 실시간 (무료)
    • real_traffic : 추천1
    • real_traffic2 : 추천2
    • rt_stats : 실시간통계
    • rt_stats_freeroad : 실시간통계(무료)
    • short_distance_priority : 단거리
    • stats : 통계
    • stats_freeroad : 통계(무료)
    • motorcycle : 이륜차
  • Response Json

    타입 설명
    header (Object) isSuccessful Boolean 성공여부
    resultCode Integer 실패 코드
    resultMessage String 실패 메시지
    routeDetail (Object) RouteInfo (Object) 경로 정보 dist Integer 경로의 총 길이 (단위 : m)
    time Integer 경로의 총 소요시간 (단위 : 분)
    sec_cnt Integer 구간정보 레코드 개수
    dtl_cnt Integer 구간 상세정보 레코드 개수
    rd_name_cnt Integer 도로 명칭 레코드 개수
    guide_name_cnt Integer 안내 명칭 레코드 개수
    cross_name_cnt Integer 교차로 명칭 레코드 개수
    dir_name_cnt Integer 방면 명칭 레코드 개수
    vtx_cnt Integer 보간점(경로 벡터 좌표) 개수
    rest_cnt Integer 휴게소 개수
    toll_cnt Integer 요금소 개수
    max_x Integer 보간점 레코드 중 최대 X 좌표
    max_y Integer 보간점 레코드 중 최대 Y 좌표
    min_x Integer 보간점 레코드 중 최소 X 좌표
    min_y Integer 보간점 레코드 중 최소 Y 좌표
    SecInfoRec (Array) 구간정보 레코드 0 Integer 구간의 거리(미터)
    1 Integer 구간 속도
    2 Integer 도로번호 혹은 도로 명칭 인덱스
    3 String 구간 상세 정보 레코드 개수
    4 String 구간 상세 정보 테이블 인덱스
    DtlInfoRec (Array) 구간상세정보 레코드 0 Integer 구간 상세 거리
    1 Integer 구간 상세 속도
    2 String 안내명칭 인덱스
    3 String 교차로명칭 인덱스
    4 String 방면명칭 인덱스
    5 String 도로 종별
    6 Integer 안내지점 보간점 인덱스
    NameRec (Array) 명칭레코드 0 String 고속도로명칭 or 안내명칭 or 교차로명칭 or 방면명칭
    VtxRec (Array) 보간점 레코드- 경로 벡터 좌표 배열 [[twX1, twY1], [twX2, twY2], … [twXn, twYn]] 0 Integer twX
    1 Integer twY
    RestRec (Array) 휴게소 레코드 0 String 고속모드 코드
    1 String 주유소 업체 코드 (0 : 없음, 1 class="ex": LG 주유소, 2 : SK 주유소, 3 : 쌍용 주유소, 4 : 한화 주유소, 5 : 현대 주유소)
    2 String LPG 유무 [0:없음, 1:있음]
    3 String 정비소 유무 [0:없음, 1:있음]
    4 String 고속모드 타입
    5 String Reserved
    6 Integer 휴게소 명칭

경로 탐색 상세(json Parsing)

경로 탐색 상세로 받은 json 결과 값을 탐색 정보를 보기 쉽게 parsing한 정보

  • Sample Code
    <script type="text/javascript src="https://api-maps.cloud.toast.com/maps/js/v1.0/route.js" > </script>
    <script type="text/javascript">
    function fnRouteParse(data){ // 경로 탐색 상세 결과값
    	
      var routeParsing = route.jsonParsing(data);
      routeParsing.routeSummaryInfo;		// 탐색 결과 종합
      routeParsing.routeDetailInfo;		// 탐색 경로 리스트
      routeParsing.vtxInfo; 			// 지도 그리기용 좌표 리스트
    }
    </script>
  • Parse Json

    타입 설명
    routeSummaryInfo (탐색 결과 종합) (Object) distance Integer 경로 총길이 (단위 : m)
    time Integer 경로의 총 소요시간 (단위 :분)
    max_x String 보간점 레코드 중 최대 X 좌표
    max_y String 보간점 레코드 중 최대 Y 좌표
    min_x String 보간점 레코드 중 최소 X 좌표
    min_y String 보간점 레코드 중 최소 Y 좌표
    routeDetailInfo (탐색 경로 리스트) (Array) distance Integer 구간 상세거리 (단위 : m)
    speed Integer 구간 상세 속도 (단위 : km/h)
    roadName String 도로명
    direction String 방향 정보
    district String 방면 정보
    cross String 안내 정보
    directionDetail String 상세 경로 설명
    vtxInfo (지도 그리기용 좌표 리스트) (Array) 0 Integer twX
    1 Integer twY

결과코드

결과 코드값 리스트

  • 결과코드

    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 인증 오류