Getting Started Guide

HERE Data SDK for TypeScript includes the core components to access the HERE APIs from any web-based application.

In this guide, learn how to authenticate to and start working with the HERE platform using the Data SDK:

Prerequisites

To start using Data SDK for TypeScript, you need a platform user account.

Working with the Data SDK requires knowledge of the following subjects:

Concepts

To use Data SDK for TypeScript, you need to understand the following concepts related to the HERE platform:

For more details, see the Data User Guide.

Get credentials

To work with catalog or service requests to the HERE platform, you need to get authentication and authorization credentials.

You can authenticate to the HERE platform within your application with the platform credentials available on the HERE portal by means of the Data SDK authentication library. For the available authentication options, see the Identity & Access Management Developer Guide.

After you set up the credentials, you can use them to access the Data SDK libraries.

Available components

The Data SDK package contains several independent modules that focus on a specific set of responsibilities:

  • olp-sdk-authentication – gets OAuth2 bearer tokens used to confirm platform requests.
  • olp-sdk-core – contains code that is common for @here/olp-sdk-dataservice-read, @here/olp-sdk-dataservice-api, and @here/olp-sdk-authentication.
  • olp-sdk-dataservice-read – gets layer and partition data from platform catalogs.
  • olp-sdk-dataservice-write – writes data to layers.
  • olp-sdk-dataservice-api – gets data from the HERE platform.
  • olp-sdk-fetch – adds a subset of the fetch API for Node.js.

Reference documentation

The API reference documentation for the Data SDK is available on our GitHub Pages.

Examples

To better understand HERE Data SDK for TypeScript, see the Examples section.

results matching ""

    No results matching ""