133 lines
5.7 KiB
JSON
133 lines
5.7 KiB
JSON
|
|
{
|
||
|
|
"info": {
|
||
|
|
"name": "Sensor Hub",
|
||
|
|
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
|
||
|
|
"description": "Sensor Hub API. GET list, GET by uuid (detail), POST add, PATCH update, DELETE delete, POST active/deactive. Authenticated user required. Static responses only."
|
||
|
|
},
|
||
|
|
"item": [
|
||
|
|
{
|
||
|
|
"name": "List sensors",
|
||
|
|
"request": {
|
||
|
|
"method": "GET",
|
||
|
|
"header": [
|
||
|
|
{"key": "Content-Type", "value": "application/json"},
|
||
|
|
{"key": "Authorization", "value": "Bearer {{token}}", "description": "Required: user must be authenticated"}
|
||
|
|
],
|
||
|
|
"url": "{{baseUrl}}/api/sensor-hub/",
|
||
|
|
"description": "Get list of sensors. GET on base route."
|
||
|
|
},
|
||
|
|
"response": [
|
||
|
|
{
|
||
|
|
"name": "Success",
|
||
|
|
"status": "OK",
|
||
|
|
"code": 200,
|
||
|
|
"body": "{\n \"status\": \"success\",\n \"data\": {\n \"name\": \"sensor-hub-static\",\n \"uuid_sensor\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"last_updated\": \"2025-02-18T12:00:00Z\",\n \"specifications\": {\n \"model\": \"SH-1\",\n \"firmware\": \"1.0.0\",\n \"capabilities\": [\"temperature\", \"humidity\", \"light\"]\n },\n \"power_source\": {\n \"type\": \"battery\",\n \"voltage\": 3.3,\n \"backup\": \"solar\"\n },\n \"customized_sensors\": {\n \"thresholds\": {\"temperature_min\": 10, \"temperature_max\": 35},\n \"report_interval_sec\": 300\n }\n }\n}"
|
||
|
|
}
|
||
|
|
]
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"name": "Get sensor details (by uuid)",
|
||
|
|
"request": {
|
||
|
|
"method": "GET",
|
||
|
|
"header": [
|
||
|
|
{"key": "Content-Type", "value": "application/json"},
|
||
|
|
{"key": "Authorization", "value": "Bearer {{token}}", "description": "Required: user must be authenticated"}
|
||
|
|
],
|
||
|
|
"url": "{{baseUrl}}/api/sensor-hub/{{uuid}}/",
|
||
|
|
"description": "Get one sensor by uuid in path."
|
||
|
|
},
|
||
|
|
"response": [
|
||
|
|
{
|
||
|
|
"name": "Success",
|
||
|
|
"status": "OK",
|
||
|
|
"code": 200,
|
||
|
|
"body": "{\n \"status\": \"success\",\n \"data\": {\n \"name\": \"sensor-hub-static\",\n \"uuid_sensor\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"last_updated\": \"2025-02-18T12:00:00Z\",\n \"specifications\": {\n \"model\": \"SH-1\",\n \"firmware\": \"1.0.0\",\n \"capabilities\": [\"temperature\", \"humidity\", \"light\"]\n },\n \"power_source\": {\n \"type\": \"battery\",\n \"voltage\": 3.3,\n \"backup\": \"solar\"\n },\n \"customized_sensors\": {\n \"thresholds\": {\"temperature_min\": 10, \"temperature_max\": 35},\n \"report_interval_sec\": 300\n }\n }\n}"
|
||
|
|
}
|
||
|
|
]
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"name": "Add sensor",
|
||
|
|
"request": {
|
||
|
|
"method": "POST",
|
||
|
|
"header": [
|
||
|
|
{"key": "Content-Type", "value": "application/json"},
|
||
|
|
{"key": "Authorization", "value": "Bearer {{token}}", "description": "Required: user must be authenticated"}
|
||
|
|
],
|
||
|
|
"body": {"mode": "raw", "raw": "{}"},
|
||
|
|
"url": "{{baseUrl}}/api/sensor-hub/",
|
||
|
|
"description": "Add a new sensor. POST on base route."
|
||
|
|
},
|
||
|
|
"response": [
|
||
|
|
{"name": "Success", "status": "OK", "code": 200, "body": "{\n \"status\": \"success\"\n}"}
|
||
|
|
]
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"name": "Update sensor",
|
||
|
|
"request": {
|
||
|
|
"method": "PATCH",
|
||
|
|
"header": [
|
||
|
|
{"key": "Content-Type", "value": "application/json"},
|
||
|
|
{"key": "Authorization", "value": "Bearer {{token}}", "description": "Required: user must be authenticated"}
|
||
|
|
],
|
||
|
|
"body": {"mode": "raw", "raw": "{}"},
|
||
|
|
"url": "{{baseUrl}}/api/sensor-hub/{{uuid}}/",
|
||
|
|
"description": "Update sensor by uuid in path. PATCH."
|
||
|
|
},
|
||
|
|
"response": [
|
||
|
|
{"name": "Success", "status": "OK", "code": 200, "body": "{\n \"status\": \"success\"\n}"}
|
||
|
|
]
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"name": "Delete sensor",
|
||
|
|
"request": {
|
||
|
|
"method": "DELETE",
|
||
|
|
"header": [
|
||
|
|
{"key": "Authorization", "value": "Bearer {{token}}", "description": "Required: user must be authenticated"}
|
||
|
|
],
|
||
|
|
"url": "{{baseUrl}}/api/sensor-hub/{{uuid}}/",
|
||
|
|
"description": "Delete sensor by uuid in path."
|
||
|
|
},
|
||
|
|
"response": [
|
||
|
|
{"name": "Success", "status": "OK", "code": 200, "body": "{\n \"status\": \"success\"\n}"}
|
||
|
|
]
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"name": "Activate",
|
||
|
|
"request": {
|
||
|
|
"method": "POST",
|
||
|
|
"header": [
|
||
|
|
{"key": "Content-Type", "value": "application/json"},
|
||
|
|
{"key": "Authorization", "value": "Bearer {{token}}", "description": "Required: user must be authenticated"}
|
||
|
|
],
|
||
|
|
"body": {"mode": "raw", "raw": "{}"},
|
||
|
|
"url": "{{baseUrl}}/api/sensor-hub/active/",
|
||
|
|
"description": "Activate. POST on active/ route."
|
||
|
|
},
|
||
|
|
"response": [
|
||
|
|
{"name": "Success", "status": "OK", "code": 200, "body": "{\n \"status\": \"success\"\n}"}
|
||
|
|
]
|
||
|
|
},
|
||
|
|
{
|
||
|
|
"name": "Deactivate",
|
||
|
|
"request": {
|
||
|
|
"method": "POST",
|
||
|
|
"header": [
|
||
|
|
{"key": "Content-Type", "value": "application/json"},
|
||
|
|
{"key": "Authorization", "value": "Bearer {{token}}", "description": "Required: user must be authenticated"}
|
||
|
|
],
|
||
|
|
"body": {"mode": "raw", "raw": "{}"},
|
||
|
|
"url": "{{baseUrl}}/api/sensor-hub/deactive/",
|
||
|
|
"description": "Deactivate. POST on deactive/ route."
|
||
|
|
},
|
||
|
|
"response": [
|
||
|
|
{"name": "Success", "status": "OK", "code": 200, "body": "{\n \"status\": \"success\"\n}"}
|
||
|
|
]
|
||
|
|
}
|
||
|
|
],
|
||
|
|
"variable": [
|
||
|
|
{"key": "baseUrl", "value": "http://localhost:8000"},
|
||
|
|
{"key": "token", "value": ""},
|
||
|
|
{"key": "uuid", "value": "550e8400-e29b-41d4-a716-446655440000"}
|
||
|
|
]
|
||
|
|
}
|