How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HERE Shadows API

The Shadows service provides an effective way to manage configurationsfor devices that are only intermittently online.The device shadow contains `reported` and `desired` state objects of a device,referred to as `reported` and `desired` shadows.The `desired` shadow contains configuration settings that the device should use and possibly alsosome optional custom settings.The device receives the `desired` shadow from HERE Tracking as a response to the ingestion request.The `reported` shadow contains the most recent position, sensor readings and settings that thedevice has sent. The reported shadow may also contain additional properties generated by HERETracking based on the device-ingested telemetry. Such properties are stored in the `system.computed`property.In case the most recent telemetry did not contain all the possiblefields, the last known information will remain in the shadow. This means that one cansee, for example, the last reported temperature or tracker firmware information in the reported shadow,even if the device did not send that information in the latest telemetry.> **IMPORTANT**> Devices should not communicate directly with this service, but should instead send the telemetry to> the ingestion endpoint, which updates the `reported` shadow and returns the `desired` shadow.> Applications should only write to the `desired` shadow and only read from the> `reported` shadow.

HERE Shadows API is one of 139 APIs that HERE publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Shadows. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 9 operations across 7 paths. It is described by OpenAPI 3.2.0, at version 2.6.11.

Requests are made against 2 base URLs: https://tracking.hereapi.com/, https://tracking.api.here.com/.

9 operations 7 paths 0 schemas 1 DELETE6 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.6.11
Base URL
https://account.api.here.com
Authentication
API Key, HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Oauth
Resource Areas
1

Authentication & Security 6

HERE Shadows API declares 6 security schemes for authenticating requests. An API key is passed in the query as apiKey (ApiKey). It accepts HTTP bearer tokens (JWT) (Bearer). It accepts HTTP bearer tokens (JWT) (UserToken). It accepts HTTP bearer tokens (JWT) (ClientToken). It accepts HTTP bearer tokens (JWT) (DeviceToken). It uses HTTP oauth authentication (signedRequest).

  • ApiKey — A key generated specifically to authenticate API requests. For more information on how to get an API key, see the [Identity & Access Management Developer Guide…
  • Bearer — A token obtained from a separate endpoint using client credentials and an OAuth 1.0a HMAC-SHA256 signed request. Users are authenticated using an OAuth 1.0 bea…
  • UserToken — This token is obtained using user's realm, username and password and then further scoped to a specific project. First obtain access token from [/users/v2/login…
  • ClientToken — This token is obtained using application's OAuth 2.0 credentials (key + secret) and then scoped to a specific project. Follow [instructions here](https://www.h…
  • DeviceToken — This access token is obtained from [/v2/token endpoint](tag/Ingestion/paths/~1v2~1token/post) using a signed request. Note: Only a small subset of our endpoint…
  • signedRequest — HERE Tracking requires that you sign your requests for tokens. The signature method uses the OAuth 1.0 standard. For more information on this standard, see the…

Paths & Operations 9

Across 7 paths, the API surfaces 9 operations — 1 DELETE, 6 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Shadows 9

The Shadows service provides an effective way to manage configurations for devices that are only intermittently online.

GET
/shadows/v2/health
Gets service health
getShadowsV2Health → 200500
GET
/shadows/v2/version
Gets service version
getShadowsV2Version → 200500
PUT
/shadows/v2/{trackingId}
Updates a device shadow
putShadowsV2ByTrackingId 4 params body → 200400401403404409413
GET
/shadows/v2/{trackingId}
Gets a device shadow
getShadowsV2ByTrackingId 3 params → 200400401403404
DELETE
/shadows/v2/{trackingId}
Clears a device shadow
deleteShadowsV2ByTrackingId 5 params → 204400401403404
POST
/shadows/v2/batch
Gets a batch of device shadows
postShadowsV2Batch 3 params body → 200400401403
GET
/shadows/v2/{trackingId}/{state}
Gets reported or desired state object of a device
getShadowsV2ByTrackingIdByState 4 params → 200400401403404
GET
/shadows/v2/{trackingId}/{state}/{selector}
Gets a value of a shadow property
getShadowsV2ByTrackingIdByStateBySelector 5 params → 200400401403404422
GET
/shadows/v4
Gets all shadows
getShadowsV4 7 params → 200400401403404

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

here-shadows-api-openapi.yml Raw ↑

Other APIs HERE publishes across the network.

HERE Geocoding and Search API
HERE Autosuggest API
HERE Tour Planning API
HERE Public Transit API
HERE Destination Weather API
HERE Map Tile API
HERE Map Image API
HERE Tracking API
HERE Positioning API
HERE Parking API
HERE Platform Data API
HERE HD Live Map
Where this information came from

This is an independent, third-party profile of HERE Shadows API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.