Introduction

In the HERE platform, the base URL for a REST API is unique for each HERE Resource Name (HRN) served by the API. This means that instead of having static base URLs for each API, the HERE platform generates a unique base URL 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.

Why Use

Use the api-lookup service to get the base URLs for REST APIs. This service can return all platform-level APIs, or all APIs for a given HRN, or information about specific APIs. For each API returned by the service, the following information is provided:

  • The API name
  • The API version
  • The base URL
  • Any parameters that the API accepts

Once you have the base URLs, you can cache them and use them repeatedly. You do not need to perform an API Lookup each time you make a request to an API.

API Lookup may return multiple versions for a single API (for example blob v1 and blob v2). Those versions may not be compatible with each other. Therefore, when retrieving the URL from API Lookup, you must take the API name (for example blob) and the API version (for example v1) into account, even when there is only one API version available. Otherwise your code might break in the future, when a new API version is introduced.

results matching ""

    No results matching ""