GuidesAPI Reference
Guides

Get started with the HERE Map Image API

Gain hands-on experience of working with the HERE Map Image API by configuring the HERE platform to process your first request.

📘

Note

For more detailed information on HERE account setup, project creation, service linking, app registration, and authentication, see the Identity & Access Management Guide.

Get a HERE account

Obtain access to the HERE platform through your organization administrator's invitation or get started for free.

  • If your company has already established a HERE platform organization, contact your organization admin who can invite you to join the organization.
  • If your company hasn’t established a HERE platform organization yet, you can get started for free. For more information, see the HERE platform pricing.

Get an API key

Register an app and create a unique API key for authenticating your requests to the HERE platform.

📘

Note

Linking the HERE Map Image API through projects is currently not supported.

  1. From the Launcher pane, select Access Manager.
  2. On the Access Manager page, click the Apps tab.
  3. On the Apps tab, click Register new app.
  4. In the Register new app window, provide the details for the new app:
    1. In the Name field, enter your app name.
    2. In the Default access to a project field, select No project.
    3. Click Register. The HERE platform creates a new app with a unique app ID.
  5. On your app page, generate up to two API keys:
    1. On the Credentials tab, select API Keys and, then click Create API Key. The HERE platform displays the API key that you created with the enabled status.
    2. Optional: To add an extra API key, click Create API key.

The following figure provides a visual summary for generating API keys:

Generating API keys for an app

Obtain a basic map image

By constructing a request URL with the necessary information and making a GET request to that URL, you can retrieve a map image from the HERE Map Image API.

  1. Construct a basic request that follows this pattern:

    https://image.maps.hereapi.com/mia/v3/{resource}/{projection}/{view}/{width}x{height}/{format}?{parameter1=value}&{parameter2=value}&...

    Consider the following example:

    https://image.maps.hereapi.com/mia/v3/base/mc/center:52.53086,13.38662;zoom=12/800x400/png
    ?apiKey={YOUR_API_KEY}

    In the preceding example:

    • https://image.maps.hereapi.com is the base URL for accessing the HERE Map Image API.
    • /mia/v3/base/mc is the getImage endpoint path indicating the specific map image request. The request uses the HERE Map Image API (mia/v3), specifies the map resource type as base, and the projection as mc (Mercator). and the desired image dimensions as 800 pixels in width and 400 pixels in height.
    • /center:52.53086,13.38662;zoom=12 specifies the coordinates of the center of the map image. In this case, the coordinates are latitude 52.53086 and longitude 13.38662. The zoom=12 parameter value is the zoom level of the map.
    • /800x400/png specifies image dimensions and the file type.
    • apiKey='YOUR_API_KEY' is the query parameter that you must replace with an actual API key. The API key serves as an authentication mechanism to ensure authorized access to the HERE Map Image API.
  2. Send the request. For example, you can use the Postman tool.

Result: A successful server response with code 200 includes a pre-rendered map image, as shown in the following example:

Map image of an area around Berlin

Next steps

  • Depending on your use case, you can modify or extend query parameters to adjust the map to your specific business needs. For example, you can change the map style, the method with which to define the map coordinates, add more features to the map, introduce custom layers of information, and so on, as described in the further sections of this guide.
  • For more advanced use cases involving the HERE Map Image API, see the Tutorials section of this guide.
  • For the terms and conditions covering this documentation, see the HERE Documentation License.