Developer Guide and API Description Guide - Version 5.1

Developer Guide and API Description Guide - Version 5.1

This article is the official 5.1 documentation for developers provided by Actility.
It contains API description, User's Guide and Developer guide.


API Description

Since 5.0 release, the OSS-API description is available at  https://oss-api.thingpark.com/    ( website powered by Swagger).  


User's Guides & Developer's Guides
  • LRC-OSS_API - User's Guide:  The OSS API User Guide explains how to use the ThingPark Wireless OSS API’s web services that allows you to control the ThingPark Wireless Applications (TWA): Connectivity Manager, Network Manager, Device Manager. This guide is based on a scenario that shows with extended examples how to manage:
    • LoRaWAN™ connectivity plans in the Connectivity Manager.
    • LoRaWAN™ base stations in the Network Manager.
    • LoRaWAN™ devices in the Device Manager.
Handling the OSS API consists in calling web services by the means of REST requests. You are invited to refer to the previous documents for the optional parameters that can be used when applying are quest.
  • LRC-AS Tunnel Interface Developer Guide (former ThingPark Tunneling API): The scope of this document is to give development guidelines on the tunnel mode interface to applications developers.
  • OSS Interface Developer Guide:  This document specifies the Device reporting interface between LRC and OSS sub-systems exposed through Kafka. This interface is designed to expose UL and DL reports to the OSS Sub-Systems for the following purposes:
    • Usage reporting
    • Key performance indicator computing
    • Alarms processing
    • Troubleshooting
The interface cannot be used to exploit data reported by devices. For this purpose the LRC/AS tunneling interface must be used.
  • LRC Provisioning API reference:  This document describes the ThingPark Wireless TWA and LRC interfaces. It is intended for developers of APIs. 



    • Related Articles

    • Developer Guides for ThingPark Wireless - Version 5.2

            Since 5.0 release, the OSS-API description is available at https://oss-api.thingpark.com/ ( website powered by Swagger). Developer Guides for ThingPark Wireless - Version 5.2 This article is the official documentation provided by Actility for ...

    • User Guide for ThingPark Wireless - Version 5.1

      This article is the official documentation provided by Actility for the 5.1 release. It will contain User's Guide, Product Description, and other reference documents.  The release notes can be found  in the release notes section (click here) User's ...

    • User Guide for ThingPark Wireless - Version 5.2

          User Guides for ThingPark Wireless - Version 5.2  This article is the official documentation provided by Actility for the 5.2 release. It will contain user guides for: ThingPark Wireless - Wireless Logger User Guide ThingPark Wireless - Operator ...

    • Product Version 5.2 - Software Release Notes

            Versions Version  Date  Author Details  Rev1  2018-11-15  Actility  First Version  Rev2  2018-11-21  Actility  Addition of the following features: RDTP-7722, RDTP-7723 and RDTP-7746  Rev3  2019-03-04  Actility  Updated versioning (release 5.2 ...

    • Product Version 5.1 - Software Release Notes

      Scope The scope of this document is to describe the release notes of the ThingPark Wireless Product Software v5.1. Version 5.1 subcomponents versioning Version 5.1 list of new introduced features (User Stories) and release notes for all ThingPark ...