API personnalisée
Afficher dans un widget les valeurs de n’importe quelle API JSON, lue par le serveur NasDash.
Le widget API personnalisée affiche les valeurs de n’importe quel service qui répond en JSON en HTTP(S) : un test de débit, la santé des disques, un onduleur, un capteur, une page d’état… tout ce qui n’a pas son propre widget.
Ajouter une API
-
Ouvrez Réglages → Intégrations → API personnalisées et choisissez API personnalisée.
-
Nommez-la et saisissez l’adresse qui répond en JSON (par exemple
https://service.example.com/api/status). -
Choisissez l’Authentification attendue par le service :
Choix Envoyé par le serveur Aucune Rien Jeton (Bearer) Authorization: Bearer <key>En-tête <name>: <key>(par exempleX-Api-Key)Utilisateur et mot de passe Authentification HTTP Basic Paramètre d’URL ?<name>=<key>ajouté à l’adresse -
N’activez Accepter un certificat auto-signé que pour un serveur qui vous appartient et en utilise un, enregistrez, puis testez la connexion.
La clé est rangée avec les autres secrets de connexion. Le serveur lit l’API (sans redirection, 1 Mio et 6 secondes au plus) ; le navigateur ne reçoit jamais l’adresse, la clé ni la réponse entière.
Choisir les valeurs
Ajoutez le widget, puis ouvrez ses réglages (✎). La réponse de l’API s’affiche à droite sous forme d’arbre. Cliquez sur + à côté d’une valeur pour l’ajouter (12 au plus) ; le + d’une liste ajoute son nombre d’éléments. Pour chaque valeur, réglez son libellé, son format (nombre, pourcentage, taille, débit, durée, date, il y a…, texte, oui/non) et son unité ; le bouton à curseurs règle les décimales, l’échelle des jauges et les seuils d’alerte et critique (avec Plus bas est pire pour une batterie ou un espace libre).
| Affichage | Montre |
|---|---|
| Chiffres | Chaque valeur en grand, avec son libellé |
| Jauges | Des anneaux sur l’échelle de chaque valeur (0–100 par défaut) |
| Liste | Libellés et valeurs, une ligne chacun |
| Tableau | Une ligne par élément d’une liste : choisissez Utiliser comme tableau sur une liste, puis les colonnes dans son premier élément (50 lignes au plus) |
| État | En service ou Problème selon une valeur ; en option la valeur qui veut dire « tout va bien » et une légende |
Le widget s’actualise de toutes les 15 s à toutes les 15 min. Plusieurs widgets qui lisent la même API partagent une seule requête.
Accès
Les visiteurs ne voient le widget qu’avec la permission API personnalisée (Réglages → Utilisateurs et accès). Seules les valeurs choisies dans un widget quittent le serveur. La démo publique lit une API fictive.