# (7) - HERE Routing API - Route Planning
In real life, we have to consider countless route planning issues every day, but most of them may be completed in your brain. And the part that the brain cannot complete, sometimes it is not really necessary to know how to go, where to turn, etc., but at least to know how long I will be there and how far away I am. This part requires the HERE Routing API. .
The function of HERE Routing API is quite powerful. In terms of the most "basic" route planning function, it has the following features:
* Support route planning for cars, trucks, locomotives, bicycles, public transportation and pedestrians.
* Can be set to avoid specific roads or areas.
* It can support real-time/historical traffic, estimate more accurate arrival time and avoid congested road sections.
* You can choose time priority or distance priority.
* You can choose to calculate several alternative routes.
* Support multilingual.
* Can avoid high-speed roads, toll roads, ferries, specific public transportation and so on.
* Can return detailed guidance information, such as road name, road shape (longitude and latitude of line segment), turn text description, public transportation transfer guide, fare, highway exit number, speed limit, etc.
* Support the special restrictions of specific countries such as license plate restrictions, exhaust volume restrictions, low pollution areas, and specific road taxes.
* Support detailed truck restriction definitions, such as length/width/height/weight/number of axles/cargo, etc.
* Support the definition of power consumption parameters of electric vehicles, and calculate the route and reachable range that are different from ordinary fuel vehicles.
## Experience the HERE route planning function
You can go to the official website of HERE Map: [https://wego.here.com/](https://wego.here.com/) to experience the function of route planning, you can enter the destination in the input box in the upper left corner , And plan the route.
For example, we can plan a route from Taipei City Government to New Taipei City Government as follows ([https://bit.ly/2ZCl8SC](https://bit.ly/2ZCl8SC)):
On the left side of the screen are the options of various vehicles. For example, after we click on the route of the car, detailed turning instructions will appear:
We can also drag any point of the route on the screen to change the location of the route:
We can also specify the departure time of the route, departure immediately or a specific point in time:
For public transportation, you can also find transfer information and detailed guidelines:
These functions and information come from HERE Routing API.
## Use HERE Routing API Reference Client to play with route planning
HERE Routing API Reference Client ([http://refclient.ext.here.com/](http://refclient.ext.here.com/)) is a tool that presents the Routing API in a web interface, because Routing There are so many parameters of the API, it is a bit difficult to be familiar with it for a while, so it will be more efficient to use the GUI provided by this tool to match the actual HTTP Request explanation.
After opening the HERE Routing API Reference Client, you will see a map centered on Berlin, Germany, with some forms and text boxes on the left. HERE Routing API is divided into two versions, V7 and V8. V7 is relatively old, but has richer functions; V8 is relatively new, but the functions are still being gradually improved. The HERE Routing API Reference Client uses V8 by default, but we will use V7 to experience it first.
Please click "New Tab +" in the upper left corner and select "Caculate Route". You will see an additional "Route 1" tab on the screen. This tab is Routing API V7; and the next "OLS 1" "Is Routing API V8.
Then we move the map to Taiwan. You can drag it directly on the map screen, or use the search function at the top of the screen. After entering a string, press "Enter" to move to the search result.
You can see that the screen is already in Taipei City, and then we can press the right mouse button on the map to try it out. A menu will appear and you can perform some related operations.
Then we right-click on two random places on the map and select "Route from" and "Route to" respectively. These two actions will fill in the relevant latitude and longitude into the "API CALL" text box below. Then press "Send" in the lower right corner to complete a route plan.
A or B on the map represent the starting point and the ending point, respectively, and both of these points can be dragged with the mouse to change the position and the result of route planning.
We can see several attributes of this route under "SUMMARY" on the right:
* BASE TIME: Journey time without considering real-time traffic conditions
* TRAFFIC TIME: Journey time considering real-time traffic conditions
* DISTANCE: journey distance
* TYPE: fastest or shortest route
In addition, you can see the instructions for each turn in "MANEUVERS", including the direction of the turn, road name, distance, etc. This part will be in English if there is no special setting. If you want to change to Chinese, please go to the input field on the left Scroll down to the "LANGUAGE" section, select "Chinese-Traditional Taiwan", and then click "Send" in the lower right corner to return Chinese.
Several attributes can be seen in "RESPONSE":
* RESPONSE TIME: the time spent in the entire Request
* BACKEND TIME: HERE background calculation time spent
* TIMESTAMP: the timestamp created by this Request
* After clicking "Show full response", the result (JSON or XML) returned by the Routing API will be displayed, such as the following JSON format text:
*
```json=
{
"response": {
"metaInfo": {
"timestamp": "2020-09-15T05:05:44Z",
"mapVersion": "8.30.112.153",
"moduleVersion": "7.2.202036-7797",
"interfaceVersion": "2.6.76",
"availableMapVersion": ["8.30.112.153"]
},
"route": [{
"waypoint": [{
"linkId": "-1075002419",
"mappedPosition": {
"latitude": 25.03873,
"longitude": 121.5518288
},
"originalPosition": {
"latitude": 25.0387309,
"longitude": 121.551791
},
"type": "stopOver",
"spot": 0.6,
"sideOfStreet": "right",
"mappedRoadName": "仁愛路四段151巷",
"label": "仁愛路四段151巷",
"shapeIndex": 0,
"source": "user"
}, {
"linkId": "+988824709",
"mappedPosition": {
"latitude": 25.0628125,
"longitude": 121.5797749
},
"originalPosition": {
"latitude": 25.062841,
"longitude": 121.5797539
},
"type": "stopOver",
"spot": 0.5319149,
"sideOfStreet": "left",
"mappedRoadName": "新湖二路",
"label": "新湖二路",
"shapeIndex": 52,
"source": "user"
}],
"mode": {
"type": "fastest",
"transportModes": ["car"],
"trafficMode": "disabled",
"feature": []
},
"shape": [25.03873, 121.5518288, 25.0384855, 121.5518224, 25.0384855, 121.5527344, 25.0384748, 121.5527558, 25.0384963, 121.5529811, 25.0389469, 121.5529704, 25.0394189, 121.5529811, 25.0403416, 121.552949, 25.0414252, 121.5529704, 25.0413823, 121.5555453, 25.0412428, 121.5609956, 25.0411892, 121.5628517, 25.0411248, 121.5642893, 25.0411248, 121.5645576, 25.0417471, 121.5649652, 25.0433779, 121.5659308, 25.0434637, 121.5659845, 25.0434852, 121.5658879, 25.0435817, 121.5659416, 25.0447297, 121.5666282, 25.045706, 121.5672398, 25.0462747, 121.5675616, 25.0476265, 121.568377, 25.0476587, 121.5684199, 25.048281, 121.5687847, 25.0484526, 121.5689027, 25.0488281, 121.5691173, 25.0490749, 121.5692353, 25.0498366, 121.5697181, 25.0499547, 121.5697718, 25.0504375, 121.5700614, 25.0509202, 121.5704048, 25.0510919, 121.5705657, 25.0514352, 121.5709949, 25.0519931, 121.5719819, 25.0527763, 121.5734732, 25.0531948, 121.574235, 25.0534308, 121.574707, 25.0536132, 121.5748787, 25.0541067, 121.5758336, 25.054493, 121.5765309, 25.0558341, 121.5790522, 25.0561452, 121.5795672, 25.0571108, 121.5813911, 25.0571537, 121.5814662, 25.0572073, 121.5814447, 25.0581944, 121.5808547, 25.0588918, 121.5803397, 25.0591385, 121.5801358, 25.0607049, 121.5789449, 25.0618422, 121.5781081, 25.0620246, 121.5784729, 25.0628125, 121.5797749],
"leg": [{
"start": {
"linkId": "-1075002419",
"mappedPosition": {
"latitude": 25.03873,
"longitude": 121.5518288
},
"originalPosition": {
"latitude": 25.0387309,
"longitude": 121.551791
},
"type": "stopOver",
"spot": 0.6,
"sideOfStreet": "right",
"mappedRoadName": "仁愛路四段151巷",
"label": "仁愛路四段151巷",
"shapeIndex": 0,
"source": "user"
},
"end": {
"linkId": "+988824709",
"mappedPosition": {
"latitude": 25.0628125,
"longitude": 121.5797749
},
"originalPosition": {
"latitude": 25.062841,
"longitude": 121.5797539
},
"type": "stopOver",
"spot": 0.5319149,
"sideOfStreet": "left",
"mappedRoadName": "新湖二路",
"label": "新湖二路",
"shapeIndex": 52,
"source": "user"
},
"length": 5024,
"travelTime": 657,
"maneuver": [{
"position": {
"latitude": 25.03873,
"longitude": 121.5518288
},
"instruction": "沿著 <span class=\"street\">仁愛路四段151巷</span> 朝 <span class=\"toward_street\">安和路一段49巷</span> 行駛, <span class=\"distance-description\">直行 <span class=\"length\">27 公尺</span></span>",
"travelTime": 16,
"length": 27,
"firstPoint": 0,
"lastPoint": 1,
"direction": "forward",
"action": "depart",
"id": "M1",
"_type": "PrivateTransportManeuverType"
}, {
"position": {
"latitude": 25.0384855,
"longitude": 121.5518224
},
"instruction": "<span class=\"direction\">左轉</span>駛入 <span class=\"next-street\">安和路一段49巷</span>, <span class=\"distance-description\">直行 <span class=\"length\">117 公尺</span></span>",
"travelTime": 29,
"length": 117,
"firstPoint": 1,
"lastPoint": 4,
"direction": "left",
"action": "leftTurn",
"id": "M2",
"_type": "PrivateTransportManeuverType"
}, {
"position": {
"latitude": 25.0384963,
"longitude": 121.5529811
},
"instruction": "<span class=\"direction\">左轉</span>駛入 <span class=\"next-street\">忠孝東路四段216巷</span>, <span class=\"distance-description\">直行 <span class=\"length\">324 公尺</span></span>",
"travelTime": 62,
"length": 324,
"firstPoint": 4,
"lastPoint": 8,
"direction": "left",
"action": "leftTurn",
"id": "M3",
"_type": "PrivateTransportManeuverType"
}, {
"position": {
"latitude": 25.0414252,
"longitude": 121.5529704
},
"instruction": "<span class=\"direction\">右轉</span>駛入 <span class=\"next-street\">忠孝東路四段</span> <span class=\"number\">(台5線)</span>, <span class=\"distance-description\">直行 <span class=\"length\">1.1 公里</span></span>",
"travelTime": 140,
"length": 1141,
"firstPoint": 8,
"lastPoint": 12,
"direction": "right",
"action": "rightTurn",
"id": "M4",
"_type": "PrivateTransportManeuverType"
}, {
"position": {
"latitude": 25.0411248,
"longitude": 121.5642893
},
"instruction": "<span class=\"direction\">左轉</span>駛入 <span class=\"next-street\">基隆路一段</span>, <span class=\"distance-description\">直行 <span class=\"length\">312 公尺</span></span>",
"travelTime": 49,
"length": 312,
"firstPoint": 12,
"lastPoint": 15,
"direction": "left",
"action": "leftTurn",
"id": "M5",
"_type": "PrivateTransportManeuverType"
}, {
"position": {
"latitude": 25.0433779,
"longitude": 121.5659308
},
"instruction": "繼續沿著 <span class=\"next-street\">環東大道匝道</span>, <span class=\"distance-description\">直行 <span class=\"length\">31 公尺</span></span>",
"travelTime": 27,
"length": 31,
"firstPoint": 15,
"lastPoint": 18,
"direction": "forward",
"action": "continue",
"id": "M6",
"_type": "PrivateTransportManeuverType"
}, {
"position": {
"latitude": 25.0435817,
"longitude": 121.5659416
},
"instruction": "沿匝道行駛, <span class=\"distance-description\">直行 <span class=\"length\">513 公尺</span></span>",
"travelTime": 50,
"length": 513,
"firstPoint": 18,
"lastPoint": 22,
"direction": "forward",
"action": "continue",
"id": "M7",
"_type": "PrivateTransportManeuverType"
}, {
"position": {
"latitude": 25.0476265,
"longitude": 121.568377
},
"instruction": "靠<span class=\"direction\">右</span>駛入 <span class=\"next-street\">市民大道高架道路</span> 朝 <span class=\"sign\"><span lang=\"zh-Hant\">環東大道</span>/<span lang=\"zh-Hant\">3</span>/<span lang=\"zh-Hant\">1</span>/<span lang=\"zh-Hant\">南港經貿園區</span></span> 行駛, <span class=\"distance-description\">直行 <span class=\"length\">296 公尺</span></span>",
"travelTime": 21,
"length": 296,
"firstPoint": 22,
"lastPoint": 29,
"direction": "bearRight",
"action": "rightFork",
"id": "M8",
"_type": "PrivateTransportManeuverType"
}, {
"position": {
"latitude": 25.0499547,
"longitude": 121.5697718
},
"instruction": "靠<span class=\"direction\">右</span>駛入 <span class=\"next-street\">環東大道</span>, <span class=\"distance-description\">直行 <span class=\"length\">644 公尺</span></span>",
"travelTime": 47,
"length": 644,
"firstPoint": 29,
"lastPoint": 37,
"direction": "bearRight",
"action": "rightFork",
"id": "M9",
"_type": "PrivateTransportManeuverType"
}, {
"position": {
"latitude": 25.0534308,
"longitude": 121.574707
},
"instruction": "從<span class=\"direction\">左側</span>出口離開朝 <span class=\"sign\"><span lang=\"zh-Hant\">內湖</span>/<span lang=\"zh-Hant\">1</span></span> 行駛, <span class=\"distance-description\">直行 <span class=\"length\">789 公尺</span></span>",
"travelTime": 77,
"length": 789,
"firstPoint": 37,
"lastPoint": 43,
"direction": "bearLeft",
"action": "leftExit",
"id": "M10",
"_type": "PrivateTransportManeuverType"
}, {
"position": {
"latitude": 25.0571108,
"longitude": 121.5813911
},
"instruction": "<span class=\"direction\">左轉</span>駛入 <span class=\"next-street\">舊宗路一段</span>, <span class=\"distance-description\">直行 <span class=\"length\">631 公尺</span></span>",
"travelTime": 111,
"length": 631,
"firstPoint": 43,
"lastPoint": 50,
"direction": "left",
"action": "leftTurn",
"id": "M11",
"_type": "PrivateTransportManeuverType"
}, {
"position": {
"latitude": 25.0618422,
"longitude": 121.5781081
},
"instruction": "<span class=\"direction\">右轉</span>駛入 <span class=\"next-street\">新湖二路</span>, <span class=\"distance-description\">直行 <span class=\"length\">199 公尺</span></span>",
"travelTime": 28,
"length": 199,
"firstPoint": 50,
"lastPoint": 52,
"direction": "right",
"action": "rightTurn",
"id": "M12",
"_type": "PrivateTransportManeuverType"
}, {
"position": {
"latitude": 25.0628125,
"longitude": 121.5797749
},
"instruction": "抵達 <span class=\"street\">新湖二路</span> 。目的地位於左側",
"travelTime": 0,
"length": 0,
"firstPoint": 52,
"lastPoint": 52,
"direction": "forward",
"action": "arrive",
"id": "M13",
"_type": "PrivateTransportManeuverType"
}]
}],
"summary": {
"distance": 5024,
"trafficTime": 896,
"baseTime": 657,
"flags": ["motorway", "builtUpArea"],
"text": "該行程需要 <span class=\"length\">5.0 公里</span>, 大約 <span class=\"time\">11 分鐘</span>",
"travelTime": 657,
"_type": "RouteSummaryType"
},
"maneuverGroup": [{
"firstManeuver": "M1",
"lastManeuver": "M13",
"mode": "car",
"summaryDescription": "開車前往 <span class=\"street\">新湖二路</span>",
"arrivalDescription": "抵達 <span class=\"street\">新湖二路</span>"
}]
}],
"language": "zh-tw"
}
}
```
You can also copy the URL in the "API CALL" text box below and use it elsewhere, but before using it, please remove the "app_code" parameter and "app_id" in it, replace it with your own APIKEY, and change Just change the URL of the Routing API. For example, the following URL applies the default parameters of the Reference Client.
For example, this is the original URL:
```javascript=
https://route.api.here.com/routing/7.2/calculateroute.json
?routeattributes=sh,gr
&mode=fastest;car
&maneuverattributes=po,ti,pt,ac,di,fj,ix
&apikey=d4QjdTHec41hIeTo2RC6_L0LxcrJVB8_JVxtUo373JE
&language=zh-tw&jsonattributes=41
&metricsystem=metric
&waypoint0=geo!stopOver!25.038731,121.551791
&waypoint1=geo!stopOver!25.062841,121.579754
&app_code=pxIXqdtgOSwQDXSDfjLQpw
&app_id=cgZPrYfgRePXzXC3PbBp
```
This is a rough description of the modified URL and parameters:
```javascript=
https://route.ls.hereapi.com/routing/7.2/calculateroute.json // URL of Routing API
?routeattributes=sh,gr // The shape of the return route (sh) and Maneuver Groups (gr)
&mode=fastest;car // The mode is to calculate the fastest route (fastest) and use the car mode (car)
&maneuverattributes=po,ti,pt,ac,di,fj,ix // The turning prompt attributes are position (po), time (ti), public transportation route (pt), action (ac), direction (di), height Expressway exit (fj), index number (ix)
&language=zh-tw // The language is zh-TW, which is Taiwanese Traditional Chinese
&jsonattributes=41 // 41 = 1 (the first character of the attribute is lowercase) + 8 (add the "_type" attribute to the object) + 32 (the shape of the return route is double instead of a string),
&metricsystem=metric // Use metric units
&waypoint0=geo!stopOver!25.038731,121.551791 // The 0th waypoint represents the starting point
&waypoint1=geo!stopOver!25.062841,121.579754 // The first waypoint, this is the end point
&apikey={APIKEY} // Your APIKEY
```
※ For detailed parameters of the calculation route, please refer to: [https://developer.here.com/documentation/routing/dev_guide/topics/resource-calculate-route.html](https://developer.here.com/documentation/ routing/dev_guide/topics/resource-calculate-route.html)
Of course, it is really not easy to understand such a variety of parameters at the first time, so [HERE Routing API Reference Client](http://refclient.ext.here.com/) is a very useful tool. The left side of the screen is divided into Two parts: "INPUT PARAMS / input parameters" and "OUTPUT PARAMS / output parameters", we first explain the part of input parameters, because this part will affect the result of route planning.
The first is the way point setting. You can set the starting point, ending point, and passing point. In addition to longitude and latitude, the input method can also be link id or street, but the most commonly used is longitude and latitude. If it is a passing point, you can also choose "stopOver / stop" or "passThrough / pass".
※ For details on routepoint parameters, please see: [https://developer.here.com/documentation/routing/dev_guide/topics/resource-param-type-waypoint.html](https://developer.here.com/documentation/ routing/dev_guide/topics/resource-param-type-waypoint.html)
In the route planning mode, you can choose different types of vehicles, choose the shortest route (shortest) or the fastest route (fastest), and whether to use real-time traffic.
In addition, you can also avoid special road types, such as "TOLLROADS / toll roads", "MOTORWAYS / high express roads", "BOAD FERRIES / ferries", "RAIL FERRIES / rail transport", "TUNNELS / tunnels", "DIRT" ROADS / sand road", "PARKS / park (only for bicycle routes)".
And for each road type, you can also choose "Strict exclude", "Soft exclude", "Avoid", "Default".
※ For details about the route mode parameters, please see: [https://developer.here.com/documentation/routing/dev_guide/topics/resource-param-type-routing-mode.html#type-route-feature-weight](https: //developer.here.com/documentation/routing/dev_guide/topics/resource-param-type-routing-mode.html#type-route-feature-weight)
"Consumption" is to set the power consumption model of electric vehicles (Consumption Model). This part is a special requirement. You can set the power consumption parameters of the vehicle at different speeds, uphill and downhill, stationary, acceleration and deceleration. . If it is a general vehicle, no special designation is required.
※ For details on power consumption model parameters, please see: [https://developer.here.com/documentation/routing/dev_guide/topics/resource-param-type-custom-consumption-details.html#type-standard](https:/ /developer.here.com/documentation/routing/dev_guide/topics/resource-param-type-custom-consumption-details.html#type-standard)
"Route Time" is the departure time or arrival time of the specified route. You can specify "NOW / Depart Now", "ANY / Don't Specify", "DEPARTURE / Departure Time", and "ARRIVAL / Arrival Time".
"Advanced Parameters" are some more advanced parameters, such as license plate restrictions that comply with legal restrictions, seasonal closed areas, restrictions related to specific vehicle types, and so on. Generally commonly used is "ALTERNATIVE ROUTES
/ Plan the number of alternative routes".
"Avoid Features" refers to avoiding a specific road or area. You can also draw the area you want to avoid on the map to avoid it.
For example, after a new avoidance area is added to the map, a detour route will be planned:
The "EXPORT ROUTE TO XML" at the bottom can output all the parameters you input into a text file in XML format, and then you can use the function of "Import Route" to add this XML file without having to enter the same parameters repeatedly.
Next, we will explain the part of "OUTPUT PARAMS / output parameters". The parameters in this part will not affect the results of route planning, but will affect the results returned by us using the Routing API, so we also need to pay attention.
"Route attributes" define the attributes of the "entire route". Of course, you can also return all of them, but the transmission time will be relatively longer. The options in this part are:
* Waypoints (Detailed attributes of the waypoints)
* Summary (route summary summary)
* Summary by country (summary summary of the route according to the country distinction)
* Shape (route shape)
* Bounding box (the rectangular range that contains the route)
* Legs (segment of the route)
* Notes (special notes)
* Lines (public transportation routes)
* Tickets (public transport ticket information)
* Labels (route label)
* Route ID (a unique ID for each route, the same route can be retrieved with other functions of getroute)
* Maneuver Groups (grouping of turning information)
* Incidents (road incidents passed by the route, such as road construction, car accidents, etc.)
* Zones (RoutingZone objects that the route passes through, need to be defined in advance)
※ For details on the route return parameters, please see: [https://developer.here.com/documentation/routing/dev_guide/topics/resource-type-route.html](https://developer.here.com/documentation/routing /dev_guide/topics/resource-type-route.html)
In addition other options such as:
※"Leg attributes" defines the segment attributes in the entire route: [https://developer.here.com/documentation/routing/dev_guide/topics/resource-type-route-leg.html](https:/ /developer.here.com/documentation/routing/dev_guide/topics/resource-type-route-leg.html)
※"Maneuver attributes" define attributes related to turning or transfer actions: [https://developer.here.com/documentation/routing/dev_guide/topics/resource-type-maneuver.html](https:// developer.here.com/documentation/routing/dev_guide/topics/resource-type-maneuver.html)
※"Link attributes" defines the detailed attributes of each road segment: [https://developer.here.com/documentation/routing/dev_guide/topics/resource-type-route-link.html](https:// developer.here.com/documentation/routing/dev_guide/topics/resource-type-route-link.html)
※"Line attributes" define the detailed attributes of public transportation routes: [https://developer.here.com/documentation/routing/dev_guide/topics/resource-type-public-transport-line.html](https:/ /developer.here.com/documentation/routing/dev_guide/topics/resource-type-public-transport-line.html)
※"Json Attributes" can set the returned JSON format: [https://developer.here.com/documentation/routing/dev_guide/topics/resource-param-type-json-representation.html](https://developer .here.com/documentation/routing/dev_guide/topics/resource-param-type-json-representation.html)
You can gradually become familiar with these by using the HERE Routing API Reference Client while comparing the files. Although there are many parameters, you will know what attributes you need to make subsequent applications after a few practical uses.
For example, if you want to draw the entire route on the map, then "shape" is indispensable; if you want to draw the different sections of the entire route on the map in different colors, then you need each "leg" "Shape"; if you want to display a basic route description, such as distance and time, then the "summary" of the entire route must be required; if you want to display the details of each turn/transfer, then you must carefully define " Parameters in "Maneuver attributes".
If you want to develop an application or web page that needs to include route calculation functions, including display of arrival time or travel time, or a map interface that needs to display routes, it is recommended to start with HERE Routing API Reference Client. And use the GUI inside to adjust the parameters. After the adjustment is satisfied, copy the URL in the "API CALL" below and apply it to your application or web page. Compared with manually modifying the parameters while viewing the document, it can be greatly improved. Shorten development time.
For example, the following figure shows a map framework using Leaflet JS, combined with the function of route planning, draws the route on the map, and displays the summary of the route, such as the length of the route and the time required.
HERE JavaScript API also integrates the route calculation function of Routing API, which can calculate the route and draw it on the map.
Sign in with Wallet
Connect another wallet