Construct a Location Request

A typical location request to the HERE Network Positioning API includes the basic elements shown in the following table and, in addition, it may contain resource-specific parameters or data.

Basic request elements

Element Value/Example Type
Global base URL https://positioning.hereapi.com/v2 URL
Azure base URL https://az.positioning.hereapi.com/v2 URL
Path /locate URL
API Key &apiKey={YOUR_API_KEY} Query parameter
Desired data &desired=altitude Query parameter
Required data &required=altitude Query parameter
Fallback modes &fallback=any|area|singleWifi Query parameter
Confidence level &confidence=68 Query parameter
Auth Token Authorization: Bearer {YOUR_TOKEN} HTTP header
Content type Content-Type: application/json HTTP header
Content encoding Content-Encoding: gzip HTTP header

Base URL

Global
Azure
https://positioning.hereapi.com/v2
https://az.positioning.hereapi.com/v2

Production environment when you use an API Key or an authentication token. For the available authentication options, see the Identity & Access Management Developer Guide.

Path

/locate

Request for positioning.

HTTPS POST only, submit data in the body of the request.

API Key

&apiKey={YOUR_API_KEY}

Substitute {YOUR_API_KEY} with your own unique apiKey. For the available authentication options, see the Identity & Access Management Developer Guide.

Desired output data

&desired=altitude

Comma-separated list of additional data fields that the service should include in the response, if the data is available. If the requested data is not available, the response contains only default data fields.

Available values are the following:

  • altitude - request to include altitude fields in the response

Required output data

&required=altitude

Comma-separated list of additional data fields that the service has to include in the response. If the requested data is not available, the request will fail.

Available values are the following:

  • altitude - request to include altitude fields in the response

Fallback modes

&fallback=any|area|singleWifi

Acceptable fallback options for cell and WLAN positioning. Values area and any apply to cell based positioning, and value singleWifi applies to WLAN based positioning. They may both be combined in the same request. By default, cell based positioning returns cell tower level location estimates only. If you allow a WGS-84 compliant geocoordinate location estimate based on LAC, RNC, TAC, NID, or RZ areas, use the fallback=area setting. If you use the fallback=any setting, the service uses all available cell fallback methods and therefore the location estimate in the response may be at the MNC, SID, or MCC level.

For privacy reasons, the precise positioning based on a single WLAN AP is not possible. You can use the fallback=singleWifi setting to allow less accurate positioning based on a single WLAN AP. In that case, the center location of the position estimate will be deviated and the reported accuracy radius will be larger.

Confidence level

&confidence=68

Confidence level in percent for the horizontal accuracy and, if requested, altitude accuracy, in the response location. If not specified, the default is 68 (this corresponds to a 68% probability that the true position is within the accuracy/uncertainty radius of the position; the higher the number, the greater the confidence level).

Valid range is [50..98].

Authentication Token

HTTP header:

Authorization: Bearer {YOUR_TOKEN}

Replace {YOUR_TOKEN} with your authentication token. For the available authentication options, see the Identity & Access Management Developer Guide.

Content Type

HTTP header:

Content-Type: application/json

Mandatory header. Used both in requests and responses.

Content Encoding

HTTP header:

Content-Encoding: gzip

Optional header, indicates gzip encoded request body content.

Example

The following is an example of the locate request that uses an API Key authentication. Make sure to include request content type in the HTTP headers.

Global
Azure
POST /v2/locate?apiKey={YOUR_API_KEY} HTTP/1.1
Host: positioning.hereapi.com
Content-Type: application/json
POST /v2/locate?apiKey={YOUR_API_KEY} HTTP/1.1
Host: az.positioning.hereapi.com
Content-Type: application/json

Note

This example uses a HERE API Key to authenticate your request. For the available authentication options, see the Identity & Access Management Developer Guide.

The POST body is as follows

{
  "wlan": [
    {
      "mac": "36:68:95:1A:36:93",
      "rss": -74
    }, 
    {
      "mac": "18:64:72:B7:BC:B2",
      "rss": -75
    },
    {
      "mac": "18:64:72:B7:89:21",
      "rss": -76
    },
    {
      "mac": "18:64:72:B7:BC:B1",
      "rss": -77
    },
    {
      "mac": "18:64:72:B7:B1:63",
      "rss": -79
    }
  ]
}

For more examples on location requests, see the following chapters:

results matching ""

    No results matching ""