API Documentation

GET

/api/v1/devices

Get a list of all devices. Returns device information including ID, name, status, and type.

Request Parameters

Parameter	Type	Required	Description
page	integer	No	Page number (default: 1)
limit	integer	No	Items per page (default: 10)

Response Example

{
  "code": 200,
  "message": "success",
  "data": {
    "devices": [
      {
        "id": 1,
        "name": "Device 1",
        "status": "online",
        "type": "sensor"
      }
    ],
    "total": 10,
    "page": 1
  }
}

POST

/api/v1/devices

Create a new device. Requires device name, type, and configuration information.

Request Body

Parameter	Type	Required	Description
name	string	Yes	Device name
type	string	Yes	Device type (sensor, actuator, etc.)
config	object	No	Device configuration

Request Example

{
  "name": "New Device",
  "type": "sensor",
  "config": {
    "interval": 60,
    "unit": "celsius"
  }
}

Response Example

{
  "code": 201,
  "message": "Device created successfully",
  "data": {
    "id": 123,
    "name": "New Device",
    "status": "offline"
  }
}

PUT

/api/v1/devices/{id}

Update device information. Replaces all device data with the provided information.

Path Parameters

Parameter	Type	Description
id	integer	Device ID

Request Example

{
  "name": "Updated Device",
  "type": "actuator",
  "config": {
    "mode": "auto"
  }
}

Response Example

{
  "code": 200,
  "message": "Device updated successfully",
  "data": {
    "id": 123,
    "name": "Updated Device",
    "type": "actuator"
  }
}

DELETE

/api/v1/devices/{id}

Delete a device by ID. This action cannot be undone.

Path Parameters

Parameter	Type	Description
id	integer	Device ID to delete

Response Example

{
  "code": 200,
  "message": "Device deleted successfully"
}

PATCH

/api/v1/devices/{id}/status

Partially update device status. Only updates the specified fields without affecting other data.

Request Body

Parameter	Type	Required	Description
status	string	Yes	Device status (online, offline, maintenance)

Request Example

{
  "status": "online"
}

Response Example

{
  "code": 200,
  "message": "Device status updated",
  "data": {
    "id": 123,
    "status": "online",
    "updatedAt": "2024-01-15T10:30:00Z"
  }
}

Developer Guide