- Products ProductsLocation Services
Solve complex location problems from geofencing to custom routing
PlatformCloud environments for location-centric solution development, data exchange and visualization
Tracking & PositioningFast and accurate tracking and positioning of people and devices, indoors or outdoors
APIs & SDKsEasy to use, scaleable and flexible tools to get going quickly
Developer EcosystemsAccess Location Services on your favorite developer platform ecosystem
- Documentation DocumentationOverview OverviewServices ServicesApplications ApplicationsDevelopment Enablers Development EnablersContent ContentHERE Studio HERE StudioHERE Workspace HERE WorkspaceHERE Marketplace HERE MarketplacePlatform Foundation and Policy Documents Platform Foundation and Policy Documents
- Pricing
- Resources ResourcesTutorials TutorialsExamples ExamplesBlog & Release Announcements Blog & Release AnnouncementsChangelog ChangelogDeveloper Newsletter Developer NewsletterKnowledge Base Knowledge BaseFeature List Feature ListSupport Plans Support PlansSystem Status System StatusLocation Services Coverage Information Location Services Coverage InformationSample Map Data for Students Sample Map Data for Students
- Help
Get started
HERE Data SDK for TypeScript provides an interface to access the HERE platform. It is a modern, lightweight, and modular SDK with minimal dependencies. The Data SDK repository is a monorepo that contains the core components of the platform SDK organized in the NPM workspace.
The Data SDK package contains independent modules that focus on a specific set of responsibilities:
-
olp-sdk-authentication– gets OAuth2 bearer tokens used to confirm platform requests. -
olp-sdk-dataservice-read– gets layer and partition data from platform catalogs. -
olp-sdk-dataservice-write– writes data to layers.
All the modules can be found in the @here subdirectory.
HERE is committed to respecting your privacy and to complying with applicable data protection and privacy laws. For more information, see the HERE Privacy Policy.
For more information on HERE data security and durability best practices, see the Data API.
Backward compatibility
We try to develop and maintain our API in a way that preserves its compatibility with the existing applications. Changes in Data SDK for TypeScript are greatly influenced by the Data API development. Data API introduces breaking changes 6 months in advance. Therefore, you may need to migrate to a new version of Data SDK for TypeScript every half a year.
For more information on Data API, see its Developer Guide and API Reference.
When new API is introduced in Data SDK for TypeScript, the old one is not deleted straight away. The standard API deprecation time is 6 months. It gives you time to switch to new code. However, we do not provide ABI backward compatibility.
All of the deprecated methods, functions, and parameters are documented in the Data SDK for TypeScript API Reference and changelog.
Prerequisites
To start using the Data SDK, you need an platform user account.
Working with the Data SDK requires knowledge of the following subjects:
- Basic understanding of the core HERE platform concepts.
- Basic proficiency with TypeScript.
To learn about the dependencies and how to install, build, and test the Data SDK, see the related documentation on GitHub.
For the terms and conditions covering this documentation, see the HERE Documentation License.
