API Dokumentation

Norwin edited this page Oct 26, 2016 · 7 revisions

Dieses Dokument beschreibt informell die bereitgestellte API und das zugrunde liegende Datenmodell.

Eine automatisch generierte und formellere Dokumentation findet sich hier.

Datenmodell

Das aktuelle Datenmodell besteht aus 3 Tabellen:

  • Boxes
  • Sensors
  • Measurements

Boxes

Dabei handelt es sich um die eigentliche Sensebox. Folgende Daten können zu einer Box gespeichert werden:

  • Name
  • Typ
  • Sensoren
  • Location

Sensors

Enthält die Sensoren einer Sensebox. Folgende Daten können zu einem Sensor gespeichert werden:

  • Titel
  • Einheit
  • Messungen

Measurements

Enthält die Messungen der einzelnen Sensoren. Folgende Daten können zu einer Messung gespeichert werden:

  • Wert
  • Sensor
  • Datum/Uhrzeit

API Endpunkt

Die aktuelle Adresse des API Endpunkts ist: https://api.opensensemap.org/

Lesen von Daten

Die folgenden Ressourcen befinden sich relativ zum API Endpunkt.

Boxes

  • alle senseBoxen
    • Method: GET
    • URL: /boxes
  • senseBox mit ID
    • Method: GET
    • URL: /boxes/:boxId
    • param: boxId=[String]

Sensors

  • angeschlossene Sensoren einer senseBox
    • Method: GET
    • URL: /boxes/:boxId/sensors
    • param: boxId=[String]

Measurements

  • alle Messungen eines Sensors einer senseBox

    • Method: GET
    • URL: /boxes/:boxId/data/:sensorId
    • params:
      • boxId=[String]
      • sensorId=[String]
  • alle Messungen eines Sensors einer senseBox in einem Zeitraum

    • Method: GET
    • URL: /boxes/:boxId/data/:sensorId?from-date=:date1&to-date=:date2
    • params:
      • boxId=[String]
      • sensorId=[String]
      • date1=[Date]
      • date2=[Date]

Schreiben von Daten

  • Messung eines Sensors einer senseBox hinzufügen
    • Method: POST
    • URL: /boxes/:boxId/:sensorId
    • Data: {"value":"sensorValue"} e.g. {"value":"12.5"}
Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.