API docs by Redocly

abcdust Sensors API (1.1.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.

Index

  • /sensors (POST): Send sensor data to the platform.
  • /test-connection (GET): Health check endpoint to verify database connectivity.

Sensors

Operations related to sensor data

Send sensor data

Accepts sensor data as JSON in the request body and stores it in ABC Dust Platform. Requires a valid token as a query parameter.

Authorizations:
ApiTokenQuery
query Parameters
token
required
string
Example: token=Xk7Pm9Nq2Rw4Vt6Yz8Ab3Cd5Ef7Gh9

API token for authentication. Must match the value obtained from ABC Dust Web Platform.

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

Altitude reading.

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 (in milliseconds since epoch).

latitude
required
number <double>

Latitude coordinate.

longitude
required
number <double>

Longitude coordinate.

conf
required
string

Configuration identifier (e.g., device type).

temperature
required
number <float>

Temperature reading.

speed
required
number <float>

Speed reading.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "message": "Data saved to MongoDB and sent to PostgreSQL",
  • "mongoId": "68336201f352a2f8f64ac570"
}

Health

Service health and status endpoints

Test database connection

Returns the status of the database connection for health checks.

Authorizations:
ApiTokenQuery

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Successfully connected to database",
  • "timestamp": "2019-08-24T14:15:22Z"
}