HERE

HERE is a platform that provides a number of location-based APIs. The Nextmv Cloud API can leverage HERE's matrix routing service to make routing decisions informed by street routes and real-time or projected traffic conditions. Nextmv's HERE integration allows you to construct measures using HERE routing data, providing more accurate routes than the haversine measure.

Endpoints

Authorization: Bearer <YOUR-API-KEY>

For the full specification, please visit the Nextmv Cloud API OpenAPI specification.

Using the integration

Follow the steps below to use the HERE integration.

1. Get the Nextmv and HERE API keys. This only needs to be done once. Note, The HERE API key will need to be associated with a plan that has access to the HERE matrix API.
2. Set up a HERE integration on Nextmv to securely store the HERE API key. We will securely store your API key and use it when you request new runs. This only needs to be done once.
3. Create a run profile for using the HERE integration when requesting new runs, using the integration id and type obtained in the previous step. This only needs to be done once.
4. Follow the Nextmv Cloud API reference guide to create a new run, using the run profile id obtained in the previous step with the run_profile key. When using a run profile with the HERE integration, you may also specify additional information to incorporate traffic. After, you can poll the status of your run and get the result.
5. Manage your configurations using the endpoints.

Using Traffic Conditions in Your Measure

You can specify real-time or historical traffic data when using the HERE integration. Traffic data is specified in the run_profile field of your JSON input when making a new run using the departure_time field (see example below). Specifying a departure_time for your vehicles will cause HERE to factor traffic conditions into its route lengths in one of two ways:

• If you set departure_time to current time, HERE will use real-time conditions.
• If you set departure_time to a future time, HERE will use estimates based on historical data.

The format for the departure time must follow an RFC3339 formatted timestamp.

{
  "run_profile": {
    "id": "my-here-integration",
    "measure": {
      "here": {
        "departure_time": "2018-12-19T18:23:45"
      }
    }
  }
}

See the HERE documentation for more information on historical and real-time traffic information. Note that we do not support the any parameter used by HERE. If you want your route lengths to be calculated without considering traffic, simply omit the departure time parameter from the run profile. If you want to use current traffic conditions, provide a timestamp for the current time.

Cost

Your HERE account will incur charges for each run of a Nextmv model that uses a run profile configured with the HERE integration. Make sure you understand the cost implications of the HERE API before you start using the HERE integration. We recommend testing against the Nextmv API using another measure, such as the Streets or haversine (default) measures to avoid incurring significant costs during development.

For each run, Nextmv will request a matrix of routes where the number of sources and destinations are equal to the number of stops plus the number of vehicle stop and end locations. For example, if your run has 1000 stops and 20 vehicles, each with start and end locations, we will request a 1040x1040 matrix.

HERE charges based on the number of "transactions" your account performs, as described in the HERE documentation. The exact cost per transaction depends on your HERE account's plan.

Set up the integration

The HERE integration lets you securely store one or more HERE API keys inside of Nextmv Cloud. Send a request to the /v1/routing/profiles/integration/here endpoint with a JSON payload that follows this schema:

A sample schema and response are provided below:

{
  "name": "My HERE Configuration",
  "id": "my-here-integration",
  "configuration": {
    "api_key": "b4**************************8a7"
  }
}

Make sure to store the id and type, as you will need them to add the integration to your run profile. Please note that you may set up multiple integration profiles using this method. You only need to do this process once for each API key.

To modify an existing HERE integration, you can use the PUT /v1/routing/profiles/integration/here/{profile_id} endpoint with a JSON payload that follows the same schema as when creating a new integration (described in the table above). Note that you may not modify the original id.