API docs by Redocly

ABC Dust Sensors API (2.0.0)

Download OpenAPI specification:

API for sending sensor data into ABC Dust Platform and checking service health. Requires a valid token as a query parameter for protected endpoints.

Multi-Tenant Support

The API supports multiple customers through client codes in the URL path. Each customer is assigned a unique client code that routes data to their tenant.

Endpoints

  • /{clientCode}/sensors (POST): Send sensor data for a specific customer
  • /test-connection (GET): Health check endpoint to verify database connectivity

Authentication

All sensor endpoints require a valid API token passed as a query parameter.

Sensors

Operations related to sensor data ingestion.

Use the /{clientCode}/sensors endpoint with your assigned client code.

Send sensor data (Multi-tenant)

Accepts sensor data as JSON in the request body and stores it in ABC Dust Platform. The clientCode path parameter identifies the customer tenant.

Available Client Codes:

  • Contact ABC Dust support to obtain your assigned client code

Requires a valid token as a query parameter.

Authorizations:
ApiTokenQuery
path Parameters
clientCode
required
string^[A-Z0-9]{6}$
Example: CU01SG

Customer client code (6 alphanumeric characters). This identifies your tenant in the multi-tenant system. Contact ABC Dust support to obtain your assigned code.

query Parameters
token
required
string
Example: token=YOUR_API_TOKEN_HERE

API token for authentication. Obtain from ABC Dust support.

Request Body schema: application/json
required
Array
altitude
required
number <float>

Altitude reading in meters.

acceleration
required
number <float>

Acceleration reading.

required
object

Contains specific device-related sensor values.

gyroscope
required
number <float>

Gyroscope reading.

timestamp
required
integer <int64>

Timestamp of the reading (milliseconds since Unix epoch).

latitude
required
number <double>

Latitude coordinate (WGS84).

longitude
required
number <double>

Longitude coordinate (WGS84).

conf
required
string

Configuration identifier (e.g., device type like "Cloudgate-Mini").

temperature
required
number <float>

Temperature reading in Celsius.

speed
required
number <float>

Speed reading in km/h.

CGSerial
string

Cloudgate device serial number.

flowmeter1
number <float>

Flowmeter channel 1 reading (mA).

flowmeter2
number <float>

Flowmeter channel 2 reading (mA).

flowmeter3
number <float>

Flowmeter channel 3 reading (mA).

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Data saved to MongoDB and PostgreSQL Lambda triggered",
  • "data": {
    }
}

Health

Service health and status endpoints

Test database connection

Returns the status of the database connection for health checks. This endpoint does not require authentication.

Authorizations:
ApiTokenQuery

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Successfully connected to database",
  • "timestamp": "2026-01-07T12:00:00.000Z"
}