Migration Guide

Modem & Geolocation Services

LoRa Cloud Modem & Geolocation Services combine the functionality of the former “Geolocation Services” (GLS) and “Device & Application Services” (DAS) under a simplified pricing structure.

What has changed?

The Modem & Geolocation Services is comprised of two core services:

1. The Modem and Geolocation API is the device-centric protocol engine for Modem-based devices. It drives the modem protocol between the on-device modem stack and the digital twin inside LoRaCloud. This message exchange facilitates the delivery of modem functionality like Advanced Transport Services. The Modem protocol also provides a fully integrated ready-to-use implementation for the LoRa Edge Platform.

2. The Geolocation API Primitives augments the Modem functionality with low-level access to geolocation solvers. This gives your geolocation applications the opportunity to build geolocation strategies that are optimized for your specific use case.

Both of these APIs are metered and priced transparently based on usage. Also, both are accessible via the API tokens which are managed via the Token Management API.

Migration from Device & Application Services (DAS) API

Modem & Geolocation Services is fully API-compatible with former Device & Application Services. Also, existing DAS API tokens remain functional. Therefore, the transition from DAS is seamless and does not require any migration steps. Existing integrations benefit instantly from the simplified pricing structure as well as the ability to call the Geolocation API Primitives with the existing token. Make sure the token capabilities for geolocation APIs are set for your token (see List of API Endpoints).

Migration from Geolocation Services (GLS) API

The functionality provided the former GLS service is equally made available in the Modem & Geolocation Services with slight modifications to the APIs. To migrate your existing GLS integration from GLS to the Modem & Geolocation Services, please make sure you consider the following steps related to

• the API Host

• the API endpoints

• the API authentication token

• the HTTP status codes

Note

Existing GLS users will be able to execute the legacy GLS APIs under gls.loracloud.com until final service termination occurs. However, no new tokens for gls.loracloud.com are created.

API Host

Switch your API integration to the new host name which is shown in the Modem & Geolocation Service Portal.

API Token

The former GLS API tokens are not valid for Modem & Geolocation Services APIs. Please create new tokens via the Service Portal Token Manager.

The HTTP token authentication header in the Modem & Geolocation Service APIs is different from the former GLS APIs. Please adapt your client implementation to use the new Authorization header.

Former GLS HTTP Token Header	New Modem & Geolocation HTTP Token Header
Ocp-Apim-Subscription-Key: <TOKEN>	Authorization: <TOKEN>

Tokens require particular token capabilities to authorize the execution of various API endpoints. Please consult the List of API Endpoints for the complete map of token capabilities.

API endpoints

The GLS API endpoints are now transitioned into the Modem & Geolocation API namespace. Please adapt your client implementation to use the new API endpoint according to this mapping table:

Former GLS API Endpoints	New Modem & Geolocation API Endpoints
POST /api/v2/rssi	POST /api/v1/solve/rssi
POST /api/v2/tdoa	POST /api/v1/solve/tdoa
POST /api/v2/rssiMultiframe	POST /api/v1/solve/rssiMultiframe
POST /api/v2/tdoaMultiframe	POST /api/v1/solve/tdoaMultiframe
POST /api/v2/loraWifi	POST /api/v1/solve/loraWifi
POST /api/v3/solve/singleframe	POST /api/v1/solve/singleframe
POST /api/v3/solve/multiframe	POST /api/v1/solve/multiframe
POST /api/v3/solve/singleframes	POST /api/v1/solve/singleframes
POST /api/v3/solve/multiframes	POST /api/v1/solve/multiframes
POST /api/v3/solve/gnss_lr1110_singleframe	POST /api/v1/solve/gnss_lora_edge_singleframe
POST /api/v3/solve/gnss_lr1110_multiframe	POST /api/v1/solve/gnss_lora_edge_multiframe
GET /api/v3/almanac/full	GET /api/v1/almanac/full

The request and response objects for these endpoints remain unchanged.

Make sure the token capabilities for these APIs are set for your token (see List of API Endpoints).

HTTP Status Codes

The HTTP status codes of the Geolocation API have been adapted to fit to the Modem & Geolocation API model. This results in improved clarity over different error conditions. Please refer to the HTTP Requests Section for more details.