This section outlines how to get started quickly using the on the HERE Platform (platform.here.com).
- Get a HERE account
- Register your app
- Get an API key
- Send a request
Note
For more detailed information on HERE account setup, app registration, and authentication, see the Identity & Access Management Developer's Guide.
Get a HERE account
A HERE account provides you with access to the HERE services you have licensed, whether you are a HERE platform user or a developer portal user.
Register your app
To register your app, follow these steps:
- Sign in to the HERE platform using your HERE account.
- Open the Access Manager from the Launcher.
- On the Apps tab, click Register new app and provide the requested information.
- Click Register. The platform creates a new app with a unique app ID.
Get an API key
To get an API key, follow these steps:
- Sign in to the HERE platform using your HERE account.
- Open the Access Manager from the Launcher.
- On the Apps tab, click the app you created in the previous section, Register your App, or an existing group app for which you want to generate an API key.
- On the Credentials tab, select API Keys then click Create API key to generate a maximum of two API Keys for your application authentication credentials. The API key is created and displayed.
Send a request
View the following example to send a request.
Sample request: Test geocoordinates
To test whether a set of geocoordinates are within a set of geoshapes available to the Fleet Telematics Geofencing, send the following GET request.
https://fleet.ls.hereapi.com/2/search/proximity.json
?apiKey=\{YOUR\_API\_KEY\}
&layer_ids=123
&key_attribute=NAME
&proximity=52.52144,13.41265
Note: This example uses a HERE API Key to authenticate your request. For the available authentication options, see the Identity & Access Management Developer Guide.
Note: The above example assumes you have uploaded the following shape file to the service.
ID NAME ABBR WKT
1 Alexanderplatz AL POLYGON((13.41252 52.52228,13.41426 52.5221,13.41522 52.52113,13.41227 52.51981,13.41252 52.52228))
The response to the above request includes the following high level elements:
- List of geoshapes (called
geometries
in the response) with the distance between the geocoordinate and the closest border of the geofence (a negative value indicates the position is inside, a positive value outside of the indicated shape). - Metadata about the request
{
"geometries": [
{
"attributes": {
"ID": "1",
"GEOMETRY_ID": "0",
"NAME": "Alexanderplatz",
"ABBR": "AL"
},
"distance": -99999999,
"nearestLat": 0,
"nearestLon": 0,
"geometry": "MULTIPOLYGON(((13.41252 52.52228,13.41426 52.5221,13.41522 52.52113,13.41227 52.51981,13.41252 52.52228)))"
}
],
"response_code": "200 OK"
}