GuidesAPI Reference
Guides

HERE Deeplinking API URL format

Each request must conform to the following format:

https://share.here.com/{share_object}/
{share_object_path_params}
?{query_params}

Every request must use the HTTP method GET.

The following table defines the elements that make up a deeplinking URL:

ElementDescription
share_objectA one-letter identifier which matches one of
- l, to share a location in the form of a set of geographic coordinates
- p, to share a place as a reference to a point of interest or an address
- r, to share a route in the form of directions
- s to share HERE WeGo app settings
- a to activate HERE WeGo Pro functionality in the HERE WeGo mobile app
share_object_path_paramsParameters that depend on the share_object. For l (location), it is a pair of coordinates. For p (place), it is a Share ID. For r (route), it is a set of waypoints separated by slashes. For s (settings), it is the category of settings, e.g. truckparams. For a (activation), it is the activation key.
query_paramsParameters describing how the share_object should be presented by the client application.

Common query parameters

The following query parameters can be used with any type of share_object:

  • t - Map Type: Specifies the map type that should be shown. The default value is normal. This is an optional parameter. If a platform does not support the requested types, it uses the closest version.
    • normal: the default cartography view
    • hybrid: a combined view of normal/satellite
    • traffic: traffic imagery combined with
    • satellite: satellite imagery view
    • pt: public transit combined view
  • z - Zoom Level: Specifies the zoom level to apply to the map. This parameter is mandatory in a shared location URL. Valid values are 0 to 20.
  • ref - Referrer: Specifies the original issuer of a share link. The value for this parameter should be a unique string identifier.

Open share links from mobile apps

From your mobile app you can open share links using the standard platform APIs for iOS and Android.

The following examples work for all share object types.

iOS:

[[UIApplication sharedApplication] openURL:[NSURL URLWithString:@"https://share.here.com/r/52.456115,13.439375/53.0999803,8.8352297"]]

Android:

Intent intent = new Intent(Intent.ACTION_VIEW, Uri.parse("https://share.here.com/r/52.456115,13.439375/53.0999803,8.8352297"));
startActivity(intent);