Skip to content

Pontosense Integration Guideline

1. Introduction

Welcome to the Pontosense Integration Platform, the central hub for managing sensor devices and integrating them seamlessly into your (the “Integrator”) systems. The Pontosense platform provides all the tools needed for efficient device management and reliable data flow, offering a full suite of features that enable secure communication between sensor devices and the Integrator’s systems.

The high-level integration workflow is illustrated in the figure below.

  • Sensor devices communicate with Pontosense servers only.
  • Integrator systems interact solely with Pontosense servers to retrieve data via API.
  • Essential data, like sensor MQTT connection certificates, can be securely retrieved via HTTP from the Pontosense server, ensuring a smooth and secure integration process.
  • The Integrator’s systems, including web portals and applications, will communicate exclusively with their own servers.
  • Device provisioning is completed via the Provisioning Software Development Kit (SDK) tool.

Integration Workflow

2. API Integration

The Pontosense API integration consists of four key components, as outlined below.

2.1. Developer Portal

The Developer Portal serves as the main entry point for developers, offering:

  • SDK and API Documentation: Comprehensive documentation and walkthroughs to help integrators connect to Pontosense services, including API resources and SDKs.
  • Access Keys and Endpoints: Credentials and endpoints required to successfully connect to Pontosense services.
  • Device Management: Key information on Devices includes basic device details, firmware version, registration status, working status, error codes, and device management controls.

2.2. Events Notification API

The Events Notification system uses MQTT-based JSON-RPC messages to notify clients of important device status updates, including:

  • Connectivity Status: Reports the online/offline status of the device.
  • Fall Status: Reports when a fall is detected by the device.
  • Occupancy Status: Reports the room occupancy status detected by the device.
  • Firmware Release: Notifies the integrator when new firmware releases are available.

Clients must subscribe to the Pontosense MQTT broker to receive these notifications. Note that this communication is unidirectional; clients cannot publish messages to the MQTT broker. The API documentation is available in Open-RPC format here: MQTT API Documentation.

2.3. System Management API

The System Management API offers comprehensive management features to clients through a RESTful HTTP interface, including:

  • Sensor Management: Oversee sensor operations, such as obtaining MQTT connection certificates, upgrading firmware, deleting sensors, retrieving data, and updating configurations.
  • Firmware Management: Handle firmware updates, including checking for and retrieving available updates.

These APIs allow clients to send requests to the Pontosense service. The API documentation is available in OpenAPI format here: HTTP API Documentation.

2.4. Provisioning SDK and Demo App

Pontosense offers a provisioning SDK and demo application to help developers quickly get started with integrating Pontosense services. The SDK is available for iOS, Android, and Flutter platforms.

3. Support

For any technical assistance during the integration process, please contact our support team at support@pontosense.com.