Skip to content

Latest commit

 

History

History
59 lines (36 loc) · 4.28 KB

GettingStartedGuide.md

File metadata and controls

59 lines (36 loc) · 4.28 KB

Getting Started Guide

This guide provides an introduction to the process of authentication to HERE Open Location Platform (OLP), a configuration of your environment and use of OLP features, including reading and writing data. API libraries enable you to access OLP data store, with support for exploring catalogs, resolving tiles, downloading layers and ingesting data to/from OLP.

OLP SDK for TypeScript includes core components for accessing OLP APIs from any web-based application. Starting points to begin using the OLP SDK for TypeScript:

OLP Prerequisite Knowledge

The use of HERE OLP SDK requires a basic understanding of the following OLP-related concepts:

For more details, see HERE OLP Data User Guide.

Getting Credentials

Before any catalog or service request to the HERE Open Location Platform, you must obtain the OLP authentication and authorization credentials.

The following two authentication approaches are available within your application:

  1. Using your platform credentials, available from the platform portal in combination with HERE OLP SDK authentication library.

Note: to obtain your platform credentials, create a new application through the Apps & Keys page. After creating your application, click Create A Key to download these credentials. For more information on obtaining platform credentials, see Manage Apps section of the Teams and Permissions User Guide.

  1. Using your app access key id and secret access key, which you can find on platform's Apps & Keys page. For more details on how to create your authentication and authorization client for retrieving HERE tokens, see Authentication and Authorization Developer's Guide.

After you set up the credentials, you can then use them to access HERE OLP SDK libraries.

Available Components

HERE OLP SDK consists of specific libraries, each with distinct functionality.

  • olp-sdk-authentification: API library for getting a HERE OAuth2 token to access OLP.
  • olp-sdk-dataservice-api: API library to retrieve data from OLP.
  • olp-sdk-dataservice-read: API library to retrieve Layer and Partition data from OLP catalogs.
  • olp-sdk-fetch: This module adds a subset of fetch API for Node.js.

Context and CatalogClient

The main entry point to the OLP is CatalogClient. This class provides a high-level interface for retrieval of OLP catalog data and configuration, and defines the following operations:

  • getLatestVersion: Fetches the latest version of the catalog
  • getVersions: Fetches a tile from this layer asynchronously

More details how to use the CatalogClient are placed in the Catalog usage example.

Layer Usage Example

Versioned Layer Read example shows how to use VersionLayerClient and how to retrieve data, metadata and partition data from versioned layer, using OLP SDK for TypeScript.