API Dokumentation

Allgemeine Leitfäden und Referenzen

Der folgende Abschnitt enthält einige Leitfäden und Referenzen zum Verständnis der Verwendung von Cital Insights API-Schnittstellen.



Swagger OpenAPI

Thingsboard API-Referenz


Cital Guide

Die Datenbank besteht im Wesentlichen aus zwei Teilen: Telemetrie und Metadaten. Beide Teile sind nur in Kombination sinnvoll.


Überblick über die Struktur Kunde <> Telemetrie


REST API Metadaten-Struktur

Beziehungen/Hierarchie

  • Relationen gruppieren Entitäten nach dem ER-Diagramm zusammen
  • Relationen können über den Relations Controller aufgerufen werden 
  • From = Parent Asset
  • To = Child Asset


Kunden

  • können über den Customer Controller aufgerufen werden
  • Zugriff auf verwandte Kunden über Relations

REST API Geräte-/Telemetrie-Struktur

Geräte-Informationen

Geräte-Metadaten

  • Zugriff über Telemetrie-Controller (Server-Attribute)
  • Verfügbare Daten: sensor_length | Einheit: Gesamtlänge des Sensors in Zentimetern

Telemetrie

  • Zugriff über Telemetrie-Controller möglich
  • Einheiten & Darstellungen: 
    • "firmware" | Einheit: major.minor.fix
    • "tempOffBoard" | Einheit: Temperatur in °C
    • "waterPotOffBoard" | Einheit: Wasserpotential im Boden in kPa
    • "batteryCharge" | Einheit: Status in %
  • Beispiele für Datenabfragen: REST HTTP Datenabfrage  

Grafische Benutzeroberfläche

  • https://iot.cital.io/
  • Gut für das Verständnis von Hintergrundmechanismen
    • Browser Inspector verwenden, um API-Aufrufe zu verfolgen

Kontakt & Hilfe

Kundenbetreuung: support@cital.io

Fragen zur Implementierung: it@valenco.ch

Have a question?