Forem: Patrick Yuen

Let’s try the HERE Routing API that has an amazing amount of functions

Patrick Yuen — Fri, 02 Dec 2022 05:27:58 +0000

Introduction

HERE Technologies is a global company that provides a number of map data and geolocation information services platform. As the API services that HERE provides have an amazing amount of functions, I would like to introduce a part of those functions to you.
https://www.here.com
　

Preparations
HERE Routing API
An amazing amount of parameters
Official demo site

Preparations

To use the API, there are 3 preparations

Register in the Developer section for HERE
Issue an API key

　
As there is a guide for registering in the official Routing API documents, let’s register!
It is free of charge to register for an API key.

　
Below is the reference page for the Routing API:
HERE Routing API reference

　
There is also a document for swagger API references.
Swagger API reference page

HERE Routing API

You might ask, what is a Routing API.
Explaining simply, a routing API is an API for searching routes between a starting position and a goal position.

　
So, the most basic usage of the API requires us to set the

Starting position
Goal positon
Method of movement parameters.

　
After that, we can call the API with curl

curl -X GET \
'https://router.hereapi.com/v8/routes?transportMode=car&origin=43.068411,141.350900&destination=43.064631,141.362023&apikey={YOUR_KEY}'

　
*Please replace {YOUR_KEY} with your API key
The starting position: origin
The goal position: destination
The mode of movement: transportMode

　
The modes of movement (transportation) are

Pedestrian
Car
Truck
Bicycle
Scooter

　
Although being able to select scooter as the mode of transportation may be unique to the HERE API, the contents introduced here are mostly available in other Routing API as well.

　
The response that we receive is as below:

{"routes":[{
    "id":"fd8bf9ac-6994-4da6-bd19-65bf43ad6360",
    "sections":[{
        "id":"e60d4705-43bc-452e-bd40-cde37d6f005f",
        "type":"vehicle",
        "departure":{
            "time":"2022-06-24T17:20:33+09:00",
            "place":{
                "type":"place",
                "location":{
                    "lat":43.0668075,
                    "lng":141.3507903
                },
                "originalLocation"{
                    "lat":43.0684109,
                    "lng":141.3509
                }
            }
        },
        "arrival":{
            "time":"2022-06-24T17:24:10+09:00",
            "place":{
                "type":"place",
                "location":{
                    "lat":43.0646414,
                    "lng":141.3620202
                },
                "originalLocation":{
                    "lat":43.064631,
                    "lng":141.3620229
                }
            }
        },
        "transport":{"mode":"car"}
        }]
    }]
}

A rich number of parameters

From here on is the special thing about the HERE Routing API.

　
Even only by simply looking at the documents, it can be seen that the API has the following optional parameters:

Getting the shape of the route
Taking into consideration the elevation for the route
Getting directions on when to turn
Getting the name of the road
Considering whether the destination is on the right or the left side of the road
Considering whether there is a median barrier
Calculating routes with multiple destinations
Caching a previously calculated route and using it for calculation of a new route
Changing the language and timezone
Adding the usage of a ferry
Setting the speed limit
Setting places to avoid
etc…

　
In the parameters, there are also some that are specialized for EVs (electric vehicles), such as the setting the charging situation of the vehicle.

　
It can be said that the API is customized for being used in the logistics industry.

　
As conclusion, I would like to show you the result for waking from Sapporo station to our office.
(Please replace YOUR_KEY with your API key)

curl -X GET \
'https://router.hereapi.com/v8/routes?transportMode=pedestrian&origin=43.068411,141.350900&destination=43.064631,141.362023&return=polyline,actions,instructions&lang=ja&apikey={YOUR_KEY}'

　
Following is the response

{
    "routes": [
        {
            "id": "e9942278-2dc3-42e9-8801-3e9b6c84f3fb",
            "sections": [
                {
                    "id": "faeea7a2-d775-4eb9-8287-2244707457d3",
                    "type": "pedestrian",
                    "actions": [
                        {
                            "action": "depart",
                            "duration": 56,
                            "length": 56,
                            "instruction": "Head south. Go for 56 m.",
                            "offset": 0
                        },
                        {
                            "action": "turn",
                            "duration": 70,
                            "length": 59,
                            "instruction": "Turn right. Go for 59 m.",
                            "offset": 1,
                            "direction": "right",
                            "severity": "quite"
                        },
                        {
                            "action": "turn",
                            "duration": 415,
                            "length": 405,
                            "instruction": "Turn left onto Kita 5Jo Teine-dori Street. Go for 405 m.",
                            "offset": 5,
                            "direction": "left",
                            "severity": "quite"
                        },
                        {
                            "action": "turn",
                            "duration": 267,
                            "length": 267,
                            "instruction": "Turn right onto Soseigawa-dori Street. Go for 267 m.",
                            "offset": 9,
                            "direction": "right",
                            "severity": "quite"
                        },
                        {
                            "action": "turn",
                            "duration": 142,
                            "length": 133,
                            "instruction": "Turn slightly left. Go for 133 m.",
                            "offset": 12,
                            "direction": "left",
                            "severity": "light"
                        },
                        {
                            "action": "turn",
                            "duration": 444,
                            "length": 444,
                            "instruction": "Turn left onto Kita 2Jo-dori Street. Go for 444 m.",
                            "offset": 15,
                            "direction": "left",
                            "severity": "quite"
                        },
                        {
                            "action": "arrive",
                            "duration": 0,
                            "length": 0,
                            "instruction": "Arrive at Kita 2Jo-dori Street.",
                            "offset": 23
                        }
                    ],
                    "departure": {
                        "time": "2022-11-22T10:34:38+09:00",
                        "place": {
                            "type": "place",
                            "location": {
                                "lat": 43.0675835,
                                "lng": 141.3511245
                            },
                            "originalLocation": {
                                "lat": 43.0684109,
                                "lng": 141.3509
                            }
                        }
                    },
                    "arrival": {
                        "time": "2022-11-22T10:57:52+09:00",
                        "place": {
                            "type": "place",
                            "location": {
                                "lat": 43.0646414,
                                "lng": 141.3620202
                            },
                            "originalLocation": {
                                "lat": 43.064631,
                                "lng": 141.3620229
                            }
                        }
                    },
                    "polyline": "BG-r0kyCqtsztI3eyH3BpV1CvEzF5B1HbiLgyCyMuiDqM0lDyDwYzoCyS7xB4MrZ2G5J6FnIgC72BiO2GywBoG4vBoGyuBqH8xBkGqwBiHkxB8BuMsE6gB",
                    "language": "en-us",
                    "transport": {
                        "mode": "pedestrian"
                    }
                }
            ]
        }
    ]
}

Official demo site

By the way, there is a website where you can try out the HERE API.
HERE Routing API demo site

　
Although it requires an authenticated HERE account, there is also an official page where support demos are shown.
HERE support site

　
As the APIs can be tried out for free, I recommend everyone who is interested to try out the API.

Original article:
https://qiita.com/northprint/items/837312c5ea7d0fd0966c

Let's try the HERE Route Matching API QGIS Plugin

Patrick Yuen — Thu, 17 Nov 2022 07:02:41 +0000

Original article (Japanese): https://qiita.com/Kanahiro/items/7d588f238df9be1e8eea

Introduction

In the world of GIS, there is a technique called “map matching” or “route matching”, which fits GPS or other location data to roads.

The simplest way to explain the technique of “route matching”, is that it is the operation used to move a point to the closest geographic feature. However, as shown below, it is not possible to create a suitable path simply by moving points. Matching based on the order of the points, and the deviation of each point is required.

Route searching technique is necessary to solve this problem. Through some Googling, you may find that some people would suggest creating your own route searching server. However, it is a difficult task for not only ordinary users of GIS, but also GIS technicians and engineers. However, this operation can also be interpreted as “inputting a series of points, and receiving the most likely line”, and there are multiple services that provides WebAPI for such an operation.

MIERUNE, which is great at developing QGIS plugins developed a plugin that uses such services to implement route matching in QGIS. In developing the plugin, we decided to use the HERE API, which is thought to be the strongest in route searching technology. This article discusses the technical details and how to use the HERE API plugin.

About HERE’s API

HERE publishes a wide range of APIs on location information and services, including APIs for maps, geocoding and route searching. HERE even publishes 5 APIs for route searching, which are shown below. (excluding the 2 deprecated APIs, as of July 2022)

HERE Routing API v8 (For route searching)
HERE Isoline Routing API v8 (For calculating service areas)
HERE Matrix Routing API v8 (For calculating routes when there are multiple points of departure and arrival)
HERE Route Matching v8
HERE Waypoints Sequence v8 (For solving the traveling salesman problem)

When only the types of APIs are considered, Mapbox also provides the same types of API. However, HERE’s route searching service also considers the realtime state of the traffic lights, search for routes that trucks can pass through, and even take in mind the range of electric vehicles (EV). It can be said that HERE’s API has a wide range of functionalities that are focused for logistics and transportation companies.

The plugin that we developed uses the HERE Route matching v8 API, and if there is demand for other plugins, we are also considering the development of plugins for the other APIs as well.

HERE Route API plugin

MIERUNE / qgis-here-api-plugin

QGIS Plugin for HERE Route API

HERE Route API Plugin

QGIS Plugin for HERE API.

QGIS Python Plugins Repository

Installation

Get Plugin

Install the plugin via QGIS Python Plugins Repository or ZIP-file downloadable from releases.

Authentication

Get API Key from HERE Platform.
From the menu bar, select Plugin -> HERE Route API Plugin -> Config and enter your API Key.

Functions

1. Route matching

Match any points in order to the most probably path, using the HERE Route Matching API.

Usage

Select Plugin -> HERE API Plugin -> Route Matching from the menu bar.
Select a point layer.
Select a sort field. (optional, default to fid)
Select a route matching mode from car, bus, bicycle or pedestrian.
Click OK and the trace will be added to the map canvas as a temporary layer.

Note
This plugin can help you to match the trace of a large dataset, which including more than 400 points. However…

View on GitHub

QGIS has to be install prior to using the plugin. Although the plugin works for any version of QGIS that starts with 3, we suggest using the latest LTR of QGIS, as the plugin may not work in versions that are too old.

Manual for the plugin

Install

Open “manage and install plugins”
Search for HERE in the list of QGIS plugins and install the HERE Route API Plugin
Confirm that the HERE Route API Plugin is installed in the plugin menu

Setting up the API key

Get an API key at HERE Platform
From the menu bar, open "Plugin", "HERE Route API Plugin", "Config", insert your API key and click on "OK"

Route matching

Route matching for this plugin conducts operations in which “The plugin takes any point layer as input, and outputs the likeliest line layer”. Because of the operation conducted by the plugin, this manual considers that a point layer exists in the QGIS project. (However, the number of features in the point layer is less than 10,000) The following explanation takes the point layer in the above image as the input. Moreover, as the API may only take 400 features at once, the request will be divided when the input layer has more than 400 features. More specifically, the plugin sends 400 features in each request, and then combine the results given by the APIs. From the menu bar open “plugin”, “HERE Route API Plugin”, and then “Route Matching”.

Select the target point layer in the Layer pulldown list
From the Sort Field pulldown list select the field that contains the order in which the points are lined up in (Optional, if it is empty, the fid field will automatically be used
From the Mode pulldown list, select car, bus, bicycle or pedestrian
Click on OK to start the operation
When the operation is finished, the results will be shown

With some acceptable deviations, the likeliest route that the points took will be shown.

Conclusion

Actually, the Route Matching API accepts a large amount of parameters. The input parameters used in the plugin is only the most general few of them. It is very difficult to utilize all of the input parameters, which also shows that the API supports a variety of use cases. As the QGIS plugin introduced in this article only covers a part of the functionalities, please also try the API yourself!

Forem: Patrick Yuen

Let’s try the HERE Routing API that has an amazing amount of functions

Introduction

Table of contents

Preparations

HERE Routing API

A rich number of parameters

Official demo site

Let's try the HERE Route Matching API QGIS Plugin

Introduction

About HERE’s API

HERE Route API plugin

MIERUNE / qgis-here-api-plugin

QGIS Plugin for HERE Route API

HERE Route API Plugin

Installation

Get Plugin

Authentication

Functions

1. Route matching

Usage

Manual for the plugin

Install

Setting up the API key

Route matching

Conclusion