Skip to content

makerspace-partheland/api-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

81 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

LoRa Geräte API

Eine RESTful API für den Zugriff auf LoRa-Geräte und deren Sensordaten des Makerspace Partheland e.V.

Übersicht

Diese API ermöglicht den Zugriff auf Daten von verschiedenen LoRa-Geräten, darunter senseBoxen und Wasserstandssensoren. Sie bietet Endpunkte zum Abrufen von Geräteinformationen, Statusabfragen und detaillierten Sensordaten.

API-Basis-URL

https://data.makerspace-partheland.de/v1

Authentifizierung

Einige Endpunkte erfordern eine Authentifizierung mittels API-Key. Der API-Key muss im Header der Anfrage als x-api-key übermittelt werden.

Hauptendpunkte

  • /LoRaDevices - Liste aller LoRa-Geräte (öffentlich zugänglich)
  • /LoRaDevices/senseboxes - Liste aller senseBox-Geräte (öffentlich zugänglich)
  • /LoRaDevices/waterlevels - Liste aller Wasserstand/Pegelstands-Geräte (öffentlich zugänglich)

Jeder Gerätetyp bietet zusätzliche Endpunkte:

  • /{gerätetyp}/health - Statusabfrage der Geräte (öffentlich zugänglich)
  • /{gerätetyp}/details - Detaillierte Informationen und Sensorenwerte zu einem bestimmten Gerät (erfordert API-Key)

Beispielanfragen

Alle LoRa-Geräte abrufe

curl -X GET "https://data.makerspace-partheland.de/v1/LoRaDevices"

Status einer bestimmten senseBox abrufen

curl -X GET "https://data.makerspace-partheland.de/v1/LoRaDevices/senseboxes/details?name=Beucha_Nr1"

Status einer bestimmten Wasserstand/Pegelstands-Gerät abrufen

curl -X GET "https://data.makerspace-partheland.de/v1/LoRaDevices/waterlevels/details?name=LDDS75_Naunhof_1"

Dokumentation

Die vollständige API-Dokumentation ist als OpenAPI (Swagger) Spezifikation verfügbar:

Unterstützung

Bei Fragen oder Problemen melde Dich bitte via: https://makerspace-partheland.de/kontakt/

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages