Eigene API
Werte einer beliebigen JSON-API in einem Widget anzeigen, gelesen vom NasDash-Server.
Das Widget Eigene API zeigt Werte jedes Dienstes, der per HTTP(S) JSON liefert: ein Geschwindigkeitstest, Festplattenzustand, eine USV, ein Sensor, eine Statusseite … alles ohne eigenes Widget.
API hinzufügen
-
Öffnen Sie Einstellungen → Integrationen → Eigene APIs und wählen Sie Eigene API.
-
Benennen Sie sie und geben Sie die Adresse ein, die JSON liefert (zum Beispiel
https://service.example.com/api/status). -
Wählen Sie die Authentifizierung, die der Dienst erwartet:
Auswahl Vom Server gesendet Keine Nichts Token (Bearer) Authorization: Bearer <key>Header <name>: <key>(zum BeispielX-Api-Key)Benutzer und Passwort HTTP-Basic-Authentifizierung URL-Parameter ?<name>=<key>an die Adresse angehängt -
Aktivieren Sie Selbstsigniertes Zertifikat akzeptieren nur für einen eigenen Server, der eines verwendet, speichern Sie und testen Sie die Verbindung.
Der Schlüssel wird bei den anderen Verbindungsgeheimnissen gespeichert. Der Server liest die API (ohne Weiterleitungen, höchstens 1 MiB und 6 Sekunden); der Browser erhält nie die Adresse, den Schlüssel oder die ganze Antwort.
Werte wählen
Fügen Sie das Widget hinzu und öffnen Sie seine Einstellungen (✎). Die Antwort der API erscheint rechts als Baum. Klicken Sie auf + neben einem Wert, um ihn hinzuzufügen (höchstens 12); das + einer Liste fügt die Anzahl ihrer Einträge hinzu. Legen Sie für jeden Wert Bezeichnung, Format (Zahl, Prozent, Größe, Datenrate, Dauer, Datum, vor …, Text, ja/nein) und Einheit fest; die Regler-Schaltfläche enthält Nachkommastellen, Skala der Anzeigen sowie Warn- und kritische Schwellen (mit Niedriger ist schlechter für einen Akku oder freien Speicher).
| Darstellung | Zeigt |
|---|---|
| Zahlen | Jeden Wert groß mit Bezeichnung |
| Anzeigen | Ringe auf der Skala jedes Werts (standardmäßig 0–100) |
| Liste | Bezeichnungen und Werte, je eine Zeile |
| Tabelle | Eine Zeile pro Eintrag einer Liste: Wählen Sie bei einer Liste Als Tabelle verwenden, dann die Spalten im ersten Eintrag (bis zu 50 Zeilen) |
| Status | In Betrieb oder Problem anhand eines Werts; optional der Wert, der „in Ordnung“ bedeutet, und eine Beschriftung |
Das Widget aktualisiert sich alle 15 s bis 15 Min. Mehrere Widgets, die dieselbe API lesen, teilen sich eine Anfrage.
Zugriff
Besucher sehen das Widget nur mit der Berechtigung Eigene API (Einstellungen → Benutzer und Zugriff). Nur die in einem Widget gewählten Werte verlassen den Server. Die öffentliche Demo liest eine fiktive API.