API Documentation: devices

Περιγραφή

Επιστροφή λίστας συσκευών με δυνατότητες φιλτραρίσματος, ταξινόμησης και σελιδοποίησης στην πλατφόρμα Globismart Smart City Platform.

Χρησιμοποιήστε παραμέτρους limit και offset για αποδοτική σελιδοποίηση. Για σταθερή σειρά αποτελεσμάτων χρησιμοποιήστε επίσης sort_by και sort_dir.

Base URL

GET [base_url]/api/devices_list.php

Query Παράμετροι

Παράμετρος	Τύπος	Υποχρεωτική	Περιγραφή
key	String	Ναι	API key για εξουσιοδότηση
device_type	String	Όχι	Φιλτράρισμα ανά τύπο (π.χ. sensor, relay, thermostat)
status	String	Όχι	Κατάσταση συσκευής (π.χ. active, inactive)
search	String	Όχι	Αναζήτηση σε όνομα/metadata
limit	Integer	Όχι	Πλήθος εγγραφών (προεπιλογή 50, μέγιστο 200)
offset	Integer	Όχι	Μετατόπιση για σελιδοποίηση (π.χ. 0, 50, 100)
sort_by	String	Όχι	Πεδίο ταξινόμησης (π.χ. created_at, device_name)
sort_dir	String	Όχι	`asc` ή `desc` (προεπιλογή `desc`)

Παράδειγμα Απόκρισης

{
  "items": [
    {
      "device_id": 5021,
      "device_name": "Thermostat A1",
      "device_type": "thermostat",
     
      "status": "active",
      "protocol": "mqtt",
      "mqtt_topic": "schools/SCH-0032/thermostats/A1",
      "location": {"lat": 40.69097, "lng": 21.67802},
      "metadata": {"model":"T-200","firmware":"1.4.2","vendor":"Globiled"},
      "created_at": "2025-08-08 12:41:21",
      "updated_at": "2025-08-08 12:41:21"
    },
    {
      "device_id": 5022,
      "device_name": "Relay B4",
      "device_type": "relay",
     
      "status": "inactive",
      "protocol": "mqtt",
      "mqtt_topic": "schools/SCH-0032/relays/B4",
      "location": null,
      "metadata": {"model":"R-20","firmware":"2.0.0"},
      "created_at": "2025-08-07 09:00:00",
      "updated_at": "2025-08-08 10:00:00"
    }
  ],
  "count": 2,
  "total": 124,
  "limit": 50,
  "offset": 0
}

Περιγραφή Πεδίων

Πεδίο	Τύπος	Περιγραφή
items	Array	Λίστα συσκευών
count	Integer	Πλήθος εγγραφών που επιστράφηκαν
total	Integer	Σύνολο εγγραφών που ικανοποιούν τα φίλτρα
limit	Integer	Όριο ανά σελίδα
offset	Integer	Μετατόπιση για σελιδοποίηση

Κωδικοί Σφαλμάτων

HTTP Code	Περιγραφή
200	Επιτυχία
401	Μη εξουσιοδοτημένη πρόσβαση
400	Μη έγκυρες παράμετροι
500	Εσωτερικό σφάλμα συστήματος ή βάσης δεδομένων

Παράδειγμα curl

curl -G "[base_url]/api/devices_list.php" \
  --data-urlencode "key=MY_SECRET_API_KEY" \
  --data-urlencode "device_type=thermostat" \
  --data-urlencode "limit=50" \
  --data-urlencode "offset=0" \
  --data-urlencode "sort_by=created_at" \
  --data-urlencode "sort_dir=desc"