GuidesAPI Reference
Guides

HERE server environment

HERE provides a production environment for handling your requests. The use cases of the production environment are listed in the following table.

PurposeSupported by Production Environment
Functional/Integration TestingYes
Load/Performance TestingNo
General Production UseYes

The production environment is not designed to support sudden, unannounced high loads, including performance tests. If you need to do performance testing, contact HERE to discuss options.

Service information endpoints

The HERE GNSS Data API provides the following endpoints for service information:

Health check

To check the health of the service, send a GET request to the /health endpoint:

GET /v2/health?apiKey={YOUR_API_KEY} HTTP/1.1

A healthy service returns:

{
  "status": "ok"
}

API version

To retrieve the API version, send a GET request to the /version endpoint:

GET /v2/version?apiKey={YOUR_API_KEY} HTTP/1.1

The response contains the API specification version and the service version:

{
  "apiVersion": "1.0.0",
  "serviceVersion": "1.0.10"
}

OpenAPI specification

To retrieve the OpenAPI specification of the API, send a GET request to the /openapi endpoint:

GET /v2/openapi?apiKey={YOUR_API_KEY} HTTP/1.1

The response is the OpenAPI specification in JSON format by default. To request YAML format, set the Accept header:

GET /v2/openapi?apiKey={YOUR_API_KEY} HTTP/1.1
Accept: application/yaml