Location Services API
Overview
The Location Services API finds device locations and serves GNSS assistance data, both for your cloud service (cloud-to-cloud) and directly for devices built with the nRF Connect SDK (device-to-cloud). Cloud-to-cloud requests use an Organization Auth Token. Device-to-cloud requests use a JSON Web Token.
The API covers:
- Cell and Wi-Fi positioning (ground fix)
- Assisted GNSS (AGNSS) and predicted GNSS (PGNSS) data for faster GNSS fixes
- Reverse geocoding of coordinates to an address
- A location history for the devices in a project
Existing nRF Cloud customers: cloud-to-cloud requests now go to paths under your organization and project, and Organization Auth Tokens replace service tokens. See the Location Services transition guide. Devices that use the nRF Connect SDK need no changes.
For help, ask on DevZone.
Authentication
- Organization Auth Token
- JSON Web Token
To authorize a request with an Organization Auth Token (OAT), send the token in the
Authorization header, e.g., using cURL: -H "Authorization: Bearer $NRFCLOUD_OAT".
An OAT authenticates requests from a cloud-to-cloud integration, granting access to your organization's resources. An Organization Admin creates one under Admin > Organization Auth Tokens; the token is shown only once, so store it securely.
Location requests authorized with an OAT are not recorded in the device's location history.
For more information on Organization Auth Tokens, see the Organization Auth Tokens documentation. For setup instructions specific to Location Services, see the Location Services Quickstart.
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |
To authorize a request with a JSON Web Token (JWT), send the token in the
Authorization header, e.g., using cURL: -H "Authorization: Bearer $JWT".
JWTs are for device-to-cloud requests: a Nordic Semiconductor device signs a JWT with its own private key to authenticate itself. Devices running the nRF Connect SDK generate and sign JWTs automatically once onboarded.
For more information on the required JWT algorithm, payload contents and how to generate JWTs, see the JWT authentication documentation.
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |