Introduction

The api-lookup service is a platform service used with the Data API to get the base URLs for REST APIs. This service can return all platform-level APIs, or all APIs for a given HERE Resource Name (HRN), as well as information about specific APIs. For each API returned by the lookup service, the following information is provided:

  • The API name
  • The API version
  • The base URL

The base URL for a REST API is unique for each HRN served by the API. Therefore, instead of having static base URLs for each API, a unique base URL is generated for each API for every HRN. For example, the base URL for the publish API for catalog A is different from the base URL for the publish API for catalog B.

Once you have the base URLs, you can cache them and use them repeatedly. You do not need to perform a lookup for the same HRN each time you make a request.

Note

The api-lookup service may return multiple versions of a single API, for example blob v1 and blob v2. However, the different versions may not be compatible with each other. Therefore, when retrieving URLs using the api-lookup service, you must take the API name (blob) and the API version (v1) into account, even when there is only one API version available. This helps prevent your code from potentially breaking in the future when a new API version is introduced.

Data privacy is of fundamental importance to HERE and our customers. We practice data minimization and don’t collect data we don’t need. And we promote pseudonymity for data subjects wherever a service does not require personal information to function. We employ privacy by design in services we develop. We strive to go beyond mere regulatory compliance and make privacy an integral part of our corporate culture. We believe that our approach to privacy is vital to earning and retaining the trust of our customers – and the bedrock of our future success as a data-driven location platform.

For more information on how data privacy is of fundamental importance to HERE and our customers, see the HERE Privacy Charter.

results matching ""

    No results matching ""