Info
info
is a resource that retrieves information about the map rendering service available on the server (metadata about the service), including the available map versions, map tile formats, resolutions, map view schemes, supported map languages, and other properties.
Metadata requests retrieve information specific to the base URLs they target. This information cannot be used in subsequent requests that use other base URLs. For example, to obtain a base map version, use metadata from the response to a request addressed to the Base Map Tiles base URL, but for a version of an aerial map, use metadata from the response to a request addressed to the Aerial Tiles base URL.
metadata
. The following example demonstrates a request to this resource.
https://{1-4}.base.maps.ls.hereapi.com
/maptile/2.1/info
?apiKey={YOUR_API_KEY}
&{param}={value}
Mandatory Query Parameters
The following table lists the mandatory parameters that need to be specified with every request. Not specifying these parameters will make the system reject the request.
Parameter | Type | Description |
---|---|---|
app_id (deprecated) | | A 20-byte Base64 URL-safe encoded string used in one of the available authentication options for the HERE Map Tile v2. If you use the app ID/app code option, you need to include an |
app_code (deprecated) | | A 20-byte Base64 URL-safe encoded string used for the authentication of the client application. If you use the app ID/app code option, you need to include an |
apiKey | | A 43-byte Base64 URL-safe encoded string used for the authentication of the client application. As a logged in user, you can generate it at https://developer.here.com/projects. API Keys never expire but you can invalidate your API Keys at any time. You cannot have more than two API Keys for one app at the same time. You must include an |
Information Specific Query Parameters
Parameter | Type | Description |
---|---|---|
callback_func | String | A function name that is wrapped around the JSON output. This technique allows for a more secure way of parsing the output with JavaScript, for example: returns: Note: The value is url-decoded, but it is the responsibility of the requester to provide a value that is JavaScript correct. |
callback_id | String | If specified (associated with callback_func), the function wrapper contains this id as the first parameter This allows the user to check if the response is actually the response to the request, and not some maliciously injected code; for example returns: Note: The value is url-decoded, but it is the responsibility of the requester to provide a value that is JavaScript correct. |
hash_for | String | Note: The usage of this parameter is deprecated Used to obtain information about a specific map version. This parameter is only valid if output is set to header . This parameter is designed to offer automated caches a simple way to relate map version strings to their current hash. The valid values of the parameter are: a string containing the map If the parameter is used, the response header contains a key, |
mgen | String | Specifies the metadata generation to use. This parameter accepts the following values:
Note: For maptile , this parameter is only available for metadata requests and output JSON. Note: For info requests, this parameter is only available when using output JSON. |
output | String | Output specifier. The API supports the following output specifier values (and output formats):
|
Metadata Request
The following example shows a request for metadata in XML format. An alternative output format is JSON. This is just an example and might not be up to date.
mgen
to get the latest format available. https://{1-4}.base.maps.ls.hereapi.com
/maptile/2.1/info
?apiKey={YOUR_API_KEY}
Metadata Response
The XML response to the above request contains the following data:
<?xml version="1.0" encoding="UTF-8"?>
<response>
<maps>
<map region="all" id="newest" />
<map region="all" newest="true" id="8.30.53.109" hash="be9b70fa2c" />
</maps>
<resolutions>
<resolution id="512" height="512" width="512" />
<resolution id="256" height="256" width="256" />
<resolution id="128" height="128" width="128" />
</resolutions>
<formats>
<format encoding="png" bbp="24" id="png" />
<format encoding="png8" bbp="8" id="png8" />
<format encoding="jpg" bbp="24" id="jpg" />
</formats>
<schemes>
<scheme id="normal.day" />
<scheme id="normal.day.grey" />
<scheme id="normal.day.transit" />
<scheme id="normal.day.custom" />
<scheme id="normal.night" />
<scheme id="normal.night.grey" />
<scheme id="pedestrian.day" />
<scheme id="pedestrian.night" />
<scheme id="carnav.day.grey" />
<scheme id="normal.day.mobile" />
<scheme id="normal.day.grey.mobile" />
<scheme id="normal.day.transit.mobile" />
<scheme id="normal.night.mobile" />
<scheme id="normal.night.grey.mobile" />
<scheme id="reduced.day" />
<scheme id="terrain.day" />
<scheme id="satellite.day" />
<scheme id="hybrid.day" />
<scheme id="terrain.day.mobile" />
<scheme id="hybrid.day.mobile" />
</schemes>
<styles>
<style id="default">
<scheme id="normal.day"/>
<scheme id="normal.day.grey"/>
<scheme id="normal.day.transit"/>
<scheme id="normal.day.custom"/>
<scheme id="normal.night"/>
<scheme id="normal.night.grey"/>
<scheme id="terrain.day"/>
<scheme id="satellite.day"/>
<scheme id="hybrid.day"/>
<scheme id="hybrid.grey.day"/>
<scheme id="pedestrian.day"/>
<scheme id="pedestrian.night"/>
<scheme id="carnav.day.grey"/>
<scheme id="reduced.day"/>
<scheme id="reduced.night"/>
<scheme id="normal.traffic.day"/>
<scheme id="normal.day.mobile"/>
<scheme id="normal.day.grey.mobile"/>
<scheme id="normal.day.transit.mobile"/>
<scheme id="normal.night.mobile"/>
<scheme id="normal.night.grey.mobile"/>
<scheme id="terrain.day.mobile"/>
<scheme id="hybrid.day.mobile"/>
<scheme id="pedestrian.day.mobile"/>
<scheme id="pedestrian.night.mobile"/>
<scheme id="normal.traffic.night"/>
</style>
<style id="fleet">
<scheme id="normal.day"/>
<scheme id="terrain.day"/>
<scheme id="hybrid.day"/>
</style>
<style id="dreamworks">
<scheme id="normal.day"/>
</style>
<style id="wings">
<scheme id="normal.day"/>
<scheme id="reduced.day"/>
</style>
<style id="flame">
<scheme id="normal.day"/>
<scheme id="hybrid.day"/>
</style>
<style id="alps">
<scheme id="normal.day"/>
<scheme id="normal.day.grey"/>
<scheme id="normal.day.transit"/>
<scheme id="normal.day.custom"/>
<scheme id="normal.night"/>
<scheme id="normal.night.grey"/>
<scheme id="terrain.day"/>
<scheme id="satellite.day"/>
<scheme id="hybrid.day"/>
<scheme id="pedestrian.day"/>
<scheme id="pedestrian.night"/>
<scheme id="carnav.day.grey"/>
<scheme id="reduced.day"/>
</style>
<style id="mini">
<scheme id="normal.day"/>
<scheme id="normal.day.grey"/>
<scheme id="normal.day.transit"/>
<scheme id="normal.day.custom"/>
<scheme id="normal.night"/>
<scheme id="normal.night.grey"/>
<scheme id="terrain.day"/>
<scheme id="satellite.day"/>
<scheme id="hybrid.day"/>
<scheme id="pedestrian.day"/>
<scheme id="pedestrian.night"/>
<scheme id="carnav.day.grey"/>
<scheme id="reduced.day"/>
</style>
</styles>
<tiletypes>
<tiletype id="maptile" />
<tiletype id="basetile" />
<tiletype id="xbasetile" />
<tiletype id="alabeltile" />
<tiletype id="labeltile" />
<tiletype id="linetile" />
<tiletype id="streettile" />
<tiletype id="lltile" />
<tiletype id="trucktile" />
<tiletype id="truckonlytile" />
<tiletype id="rctile" />
<tiletype id="rconlytile" />
<tiletype id="rcdistonlytile" />
<tiletype id="trucknopttile" />
<tiletype id="mapnopttile" />
</tiletypes>
<languages>
<language id="ARA" />
<language id="CHI" />
<language id="CHT" />
<language id="DUT" />
<language id="ENG" />
<language id="FRE" />
<language id="GER" />
<language id="GLE" />
<language id="GRE" />
<language id="HEB" />
<language id="HIN" />
<language id="IND" />
<language id="ITA" />
<language id="PER" />
<language id="POL" />
<language id="POR" />
<language id="RUS" />
<language id="SIN" />
<language id="SPA" />
<language id="THA" />
<language id="TUR" />
<language id="UKR" />
<language id="URD" />
<language id="VIE" />
<language id="ENG" />
</languages>
<zoomLevels min="0" max="20" />
</response>
The table below describes the XML elements in this output.
Element | Description |
---|---|
maps | Available maps. A map has the following attributes: |
resolutions | Supported map tile image resolutions. A resolution has the following attributes: |
formats | Supported image formats. A format has the following attributes: |
schemes | List of all supported map tile schemes. A |
styles | List of all supported styles. Every style supports certain List of |
tiletypes | Supported map tile types. A |
languages | Supported languages for rendered map tiles. A language has the following attribute: |
zoomLevels | Minimum and maximum values for the zoom parameter in a map tile request. |