ThingPark X IoT Flow API

API Structure

The ThingPark X IoT Flow API exposes 8 resources:

Resource	Description
Driver	Endpoints describing available drivers.
Codec	Endpoints for manually encoding/decoding payloads.
Ontology	Endpoints injecting and retrieving units/sensors available in the ontology database.
Connector	Endpoints describing connectors (e.g., AWS, Azure, MQTT).
Connection	Endpoints to manage cloud platform connections, including state and metrics.
Flow	Endpoints to manage the relationship between devices and connections.
Event	Retrieve events such as: time-based logs, connection stops/restarts, or errors during IoT Flow setup/execution.
Processor	Endpoints to orocess an uplink.

Getting Started Using the REST API with the Swagger UI

Swagger UI is a tool allowing you to interact with APIs documented with a Swagger signature without writing code. Two environments are available for developing your web service application:

• Community environment: Ideal for development and debugging. This environment may offer beta versions of APIs that are more recent than the "Latest" production version. ThingPark SaaS customers receive email notifications when new beta and pre-production versions of DX are released. To test these versions, you must explicitly set the new API version. The "Latest" version is updated only after the beta/pre-production validation period concludes.

  • https://community.thingpark.io/iot-flow/v1/swagger-ui/index.html#/

• Production environment: Recommended for stable applications, pointing to the "Latest" API version. The production environment URL depends on your instance name

  • https://iot.thingpark.com/iot-flow/v1/swagger-ui.html (opens new window)

  • https://thingparkenterprise.eu.actility.com/iot-flow/v1/swagger-ui/index.html (opens new window)

  • https://thingparkenterprise.us.actility.com/iot-flow/v1/swagger-ui/index.html (opens new window)

  • https://thingparkenterprise.au.actility.com/iot-flow/v1/swagger-ui/index.html (opens new window)

Authentication Process

To start using the API, you need to be authenticated on the DX API framework, using standard OAuth2. Each request is verified for authentication using Dx-Admin API

Full API documentation can be found here: Dx-Admin documentation