GuidesAPI Reference
Guides

How to use the Data API to fetch indoor maps

Use cases

If you need your indoor map data in the Map Object Model (MOM) format, you render it using the Platform Data API.

This tutorial provides instructions on the following:

  • Create the required credentials for the data download.
  • Find the required parameters for the data download.
  • Fetch all indoor maps using the OLP CLI.
  • Fetch a single indoor map using the OLP CLI.

Prerequisites

Application credentials

Access to your data is possible via the platform applications in your Indoor Maps project. Each application can have two sets of OAuth2 credentials, which authorize access. To get the OAuth2 KEY ID and KEY SECRET for the Default Map Collection App:

  1. Sign in to the HERE platform using your HERE account.
  2. Open the Access Manager from the launcher.
  3. Select the the Apps tab.
  4. Select Show all apps and locate the Default Map Collection App.
  5. Create the OAuth2 credentials for this App. You must be an Org Admin with management rights enabled for all apps and resources. Note that you need to download the credentials and store them in a safe place, as the platform portal does not allow you to re-download credentials.
📘

Note

The OAuth2 credentials are used as described in the section OLP CLI Configuration.

You can also create your own application for this purpose. The application must have read permissions for the main maps catalog.

How to find the main indoor maps catalog HRN

You can find the main indoor map catalog HRN from the HERE platform by selecting Data from the HERE platform launcher, and then searching for -maps.

Indoor map UUID

When accessing a single indoor map, you must have the Indoor Map UUID parameter, which you can obtain from the Indoor portal.

Bearer token

HERE platform Data API uses bearer tokens for authentication.

Once you have obtained the credentials for an application, you can get the bearer token. When using the the OLP CLI, use the following command to fetch a token.

olp api token get --quiet

Fetch indoor maps from the Versioned Layer

For more information on using versioned layers of the main maps catalog, see the Data API guide.

📘

Note

The indoor map data is Gzip compressed, and must be uncompressed before it can be used.

How to fetch all indoor maps using the OLP CLI

With OLP CLI, all indoor maps can be fetched with the following command:

olp catalog layer partition get <Catalog HRN> models --all

How to fetch an indoor map using the OLP CLI

With the OLP CLI, an indoor map can be fetched with the following command:

olp catalog layer partition get <Catalog HRN> models --partitions <Indoor Map UUID> --output <Output Path>

High level SDKs

In addition to the OLP CLI, there are also other high level SDKs available: