Integrazioni

API personalizzata

Mostrare in un widget i valori di qualsiasi API JSON, letta dal server NasDash.

Il widget API personalizzata mostra i valori di qualsiasi servizio che risponde in JSON via HTTP(S): un test di velocità, lo stato dei dischi, un UPS, un sensore, una pagina di stato… tutto ciò che non ha un widget proprio.

Aggiungere un’API

  1. Apri Impostazioni → Integrazioni → API personalizzate e scegli API personalizzata.

  2. Dalle un nome e inserisci l’indirizzo che risponde in JSON (per esempio https://service.example.com/api/status).

  3. Scegli l’Autenticazione richiesta dal servizio:

    SceltaInviato dal server
    NessunaNiente
    Token (Bearer)Authorization: Bearer <key>
    Intestazione<name>: <key> (per esempio X-Api-Key)
    Utente e passwordAutenticazione HTTP Basic
    Parametro URL?<name>=<key> aggiunto all’indirizzo
  4. Attiva Accetta un certificato autofirmato solo per un tuo server che lo usa, salva e prova il collegamento.

La chiave è conservata con gli altri segreti di collegamento. Il server legge l’API (senza reindirizzamenti, al massimo 1 MiB e 6 secondi); il browser non riceve mai l’indirizzo, la chiave né la risposta completa.

Scegliere i valori

Aggiungi il widget e apri le sue impostazioni (✎). La risposta dell’API appare a destra come un albero. Fai clic su + accanto a un valore per aggiungerlo (al massimo 12); il + di un elenco aggiunge il numero dei suoi elementi. Per ogni valore imposta etichetta, formato (numero, percentuale, dimensione, velocità, durata, data, tempo fa, testo, sì/no) e unità; il pulsante con i cursori regola i decimali, la scala degli indicatori e le soglie di avviso e critica (con Più basso è peggio per una batteria o uno spazio libero).

VisualizzazioneMostra
CifreOgni valore in grande, con la sua etichetta
IndicatoriAnelli sulla scala di ogni valore (0–100 per impostazione predefinita)
ElencoEtichette e valori, uno per riga
TabellaUna riga per elemento di un elenco: scegli Usa come tabella su un elenco, poi le colonne nel suo primo elemento (fino a 50 righe)
StatoIn servizio o Problema in base a un valore; facoltativamente il valore che significa «tutto bene» e una didascalia

Il widget si aggiorna da ogni 15 s a ogni 15 min. Più widget che leggono la stessa API condividono una sola richiesta.

Accesso

I visitatori vedono il widget solo con il permesso API personalizzata (Impostazioni → Utenti e accesso). Escono dal server solo i valori scelti in un widget. La demo pubblica legge un’API fittizia.