Skip to main content

Maps and routing providers

RushHour uses maps and location services in many places: the maps on the Dispatch board and in orders, address search when you type a stop, the driving directions and miles used to price and plan routes, and the stop order suggested by Reroute.

Out of the box, all of this works without any setup. If your company prefers another provider, or wants to use its own account, you can change it under Settings → Integrations.

Two separate choices​

It helps to think of maps and location services as two different settings.

ChoiceWhat it controlsWhere you set it
Map providerOnly the map pictures — the background map your team sees in the Company Portal and your customers see in the Customer Portal.The Map Provider row in Settings → Integrations
Location servicesAddress search and geocoding, driving directions and mileage, and route optimization.The settings of each provider (Radar, HERE, Mapbox, Trimble Maps, Valhalla, VROOM) — each capability has its own switch

Choosing Radar Maps as the map provider does not by itself make Radar look up your addresses, and turning on Radar for directions does not change the map pictures. Set both if you want one provider for everything.

Default behaviour​

If you change nothing:

  • Maps are drawn with Google Maps.
  • Address search, geocoding and driving directions use RushHour's own Google Maps account.
  • Reroute orders stops with RushHour's built-in method.

Choose the map provider​

  1. Go to Settings → Integrations and find the Map Provider row near the bottom of the list, just above AI Provider (Bring Your Own Key).
  2. Pick Google Maps, OpenStreetMap, Radar Maps, HERE Maps or Mapbox.

The choice is saved immediately for the whole company. Maps switch to the new provider the next time a page is loaded, so reload the page to see it. Trimble Maps appears in the list but can't be selected — Trimble is available for location services only.

For Radar Maps, HERE Maps and Mapbox, set up the provider's keys first (see below). If the keys are missing or the provider is turned off, RushHour shows OpenStreetMap maps instead of a blank map.

The ⋮ menu on the Map Provider row opens the settings for Google Maps (Add Keys or Edit Keys), OpenStreetMap, Radar, HERE, Mapbox and Trimble Maps directly. Valhalla and VROOM aren't in this menu; open them from their own rows.

Google Maps with your own key​

By default RushHour uses its own Google Maps account. To use your company's Google Cloud account instead:

  1. In Google Cloud, create an API key that can use Google's web services for geocoding, directions, distance calculations and places. RushHour calls Google from its servers, so don't restrict the key to website addresses.
  2. On the Map Provider row, open ⋮ → Add Keys, paste the key and select Save.

RushHour then uses your key, instead of its own, for your company's Google address lookups and directions. The map pictures in the browser keep using RushHour's Google Maps setup. The saved key isn't displayed again; to replace it, save a new one.

If a map shows Add Valid Map Keys, Google Maps couldn't be loaded in your browser. Reload the page, and contact RushHour support if the message stays.

OpenStreetMap​

OpenStreetMap maps work without a key. Under ⋮ → OpenStreetMap settings you can enter a Custom tile server URL — a tile address containing the {z}, {x} and {y} placeholders — from a tile provider you have an account with. Leave it empty to use the public OpenStreetMap tile server, which suits trying things out; for everyday use by a whole team, use your own tile provider. Map credits stay visible either way.

Location service providers​

Each of these providers is connected with your own account. On its row in Settings → Integrations, select Install or View and fill in its settings. Radar, HERE, Mapbox and Trimble Maps can also be opened straight from the Map Provider ⋮ menu. Every provider has an Enabled switch, so you can turn it off without losing its settings, and a Test connection button that checks your settings without saving them.

ProviderAddress searchDirections and mileageRoute optimizationMap pictures
RadarYesYes (truck or car)YesYes
HEREYesYes (truck or car)YesYes, with a second browser key
MapboxYesYes (car only — not truck-aware)YesYes
Trimble MapsYesYes—No
Valhalla Routing—Yes (truck or car)—No
VROOM Route Optimization——YesNo

Radar​

  • Publishable key (required) — starts with prj_live_pk_ or prj_test_pk_. It is the only Radar key sent to web browsers, and it is enough for maps, address search and directions.
  • Secret key (optional) — starts with prj_live_sk_ or prj_test_sk_. Used only by RushHour's servers, in place of the publishable key.
  • Use Radar for — switches for Address search & geocoding, Directions & mileage and Route optimization.
  • Vehicle profile (Truck or Car), Map style, and an optional Country filter — comma-separated country codes such as US,CA that limit address search results.

RushHour refuses to save a secret key in the publishable field or the other way round, and warns you if you enter test keys.

HERE​

  • API key (server) (required) — used by RushHour's servers for address search, directions and optimization. It is never sent to browsers.
  • Browser API key (optional) — a second HERE key, restricted to your portal addresses, used only to draw HERE maps. Without it, HERE maps fall back to OpenStreetMap. RushHour won't accept the server key here.
  • Use HERE for switches, Vehicle profile, Map style and Country filter, as for Radar.

Mapbox​

  • Public token (required) — starts with pk.. Used to draw Mapbox maps, and enough for address search and directions. Restrict it to your portal addresses in your Mapbox account.
  • Secret token (optional) — starts with sk.. Used only by RushHour's servers.
  • Use Mapbox for switches, Routing profile (Driving or Driving (live traffic)), Map style and Country filter.

Mapbox directions have no truck profile, so routes and miles are calculated for a car.

Trimble Maps​

  • API key — your Trimble Maps (PC*MILER) key. It is used only on RushHour's servers. The field can be left blank, but Trimble then only works if RushHour provides a Trimble key for your account; use Test connection to find out.
  • Use Trimble Maps for — Address search & geocoding and Directions & mileage.
  • Region — where Trimble searches for addresses; North America by default.

The dialog also shows a Toll costs switch. Toll amounts aren't currently calculated through this integration, so the switch doesn't change your prices. See TollGuru toll estimates.

Valhalla Routing​

An open-source routing engine for directions and mileage, with a Truck or Auto (car) costing model.

  • Mode: External API — enter the API Host of a Valhalla server you run or subscribe to, and an API key if it needs one. If you change the host, enter the API key again.
  • Mode: Self-hosted (managed by RushHour) — uses an engine run by RushHour, with no host or key. It only works where RushHour has that engine available; Test connection tells you.

VROOM Route Optimization​

An open-source route optimizer used by Reroute.

  • Mode — External API (with API Host, optional key and Endpoint style) or Self-hosted (managed by RushHour), with the same availability note as Valhalla.
  • Routing profile (optional) — must match a profile set up on the VROOM server. Leave it blank for the server's default.

When several providers are turned on​

RushHour asks providers in a fixed order and uses the first one that is turned on for the task. If Valhalla, VROOM, Radar, HERE or Mapbox fails, RushHour moves on to the next one in the order.

TaskOrder
Address searchRadar → HERE → Mapbox → Trimble Maps or Google Maps
Directions and mileageValhalla → Radar → HERE → Mapbox → Trimble Maps or Google Maps
Route optimization in RerouteVROOM → Radar → HERE → Mapbox → RushHour's built-in method

A few things to know:

  • Trimble Maps and Google Maps are alternatives, not a backup for each other. When Trimble Maps is turned on for address search or for directions, Google Maps isn't used for that task, even if Trimble Maps can't answer — so a Trimble Maps outage does interrupt that task.
  • Optimization only applies to Optimize by distance. Optimize by priority always uses RushHour's built-in method. See Optimize a route.
  • Radar, HERE and Mapbox optimize only a limited number of stops for each day of a route. If a day has more stops than a provider accepts, RushHour tries the next provider in the order and otherwise uses its built-in method. RushHour doesn't apply such a limit to VROOM.
  • Directions affect prices. The miles used to price quotes and orders come from the directions provider. Switching providers, or switching between truck and car profiles, can change the miles — and so the price — calculated for new quotes.

Turn a provider off​

  • A location service provider: open its settings, turn off Enabled and save. Its row goes back to Install, and its keys stay saved for later. RushHour moves on to the next provider in the order above.
  • A secret key only: use the remove button next to the key field, then save.
  • The map provider: pick another option on the Map Provider row, then reload the page.

Common issues​

The map is plain OpenStreetMap although I chose Radar, HERE or Mapbox. The provider's browser key is missing, or the provider's Enabled switch is off. For HERE, add the separate Browser API key.

I chose a new map provider but nothing changed. Reload the page.

Address search still looks like Google. The map provider only changes map pictures. Turn on Address search & geocoding in the provider's settings.

Test connection fails. Check that the key is for the right product and account, that it isn't a test key where you need a live one, and — for Valhalla and VROOM — that the host is reachable from the internet.

Miles on new quotes changed. A different directions provider or vehicle profile is now in use. See When several providers are turned on.

Who can change these settings​

Setting up Radar, HERE, Mapbox, Trimble Maps, Valhalla and VROOM needs the Company Admin role.