Monitor the API

The /health, /version, and /openapi endpoints allow you to check the API health, the current service version as well as obtain the full API specification, respectively.

Check API health

Verify the service is operational by making the following requests to the /health endpoint:

Request example

curl "https://evprofiles.tourplanning.hereapi.com/v1/health?apiKey=YOUR_API_KEY"

Response

The following snippet shows the corresponding response, in the JSON format:

{
  "status": "ok"
}

Get API version

Retrieve current API version information by making the following request to the /version endpoint:

Request example

curl "https://evprofiles.tourplanning.hereapi.com/v1/version?apiKey=YOUR_API_KEY"

Response

The following snippet shows the corresponding response, in the JSON format:

{
  "apiVersion": "1.0.0"
}

Get OpenAPI specification

Retrieve the complete API specification in OpenAPI 3 format by making the following request to the /openapi endpoint:

Request examples

curl "https://evprofiles.tourplanning.hereapi.com/v1/openapi?apiKey=YOUR_API_KEY"

The response format can be specified via the Accept header and can be JSON or YAML as shown in the following example:

curl -H "Accept: application/yaml" "https://evprofiles.tourplanning.hereapi.com/v1/openapi?apiKey=YOUR_API_KEY"

Response

Returns the complete OpenAPI 3.0.3 specification document with all endpoint definitions, schemas, and examples.

Next steps

After verifying the API health and reviewing the OpenAPI specification, you can proceed with retrieving and using EV profile metadata. For more information, see Get EV metadata process.