Page History

Concept

Les routes ( appels REST )

Les routes suivantes sont mises à disposition par l'API.

Sécurité

L'api est requêtable en HTTP / HTTPS ( via un certificat TLS 1.1/ 1.2 ) en fonction du paramétrage du module ( voir la page Configuration du broker-module-livedata ).

Authentification

Le contrôle d'accès à l'API V2 du module se fait en utilisant le token défini dans le fichier de configuration via le paramètre broker_module_livedata__token  pour l'API V1

• Le Token devra être présent dans le header http de la requête :
  • { x-api-token : "TOKEN" }
    
    
• L'ensemble des éléments visibles par cette API est le même que celui de l'administrateur Shinken 

• Le mécanisme d'authentification sera modifié dans les prochaines versions

Exemple : 

curl -s -S -H 'x-api-token: change_me' -d "output_format=elements_on_same_level" \
http://broker-module-livedata:50100/api/v2/inventory

• UUID et nom des météos existantes
  • Publié ou non

/get/<uuid>

• Retourne le JSON de la météo

/create

• La météo peut avoir le nom d'une météo déjà existante
• L'API retourne l'UUID de la vue
• Création d'une vue uniquement : Pas de contenu à la création

/update/<uuid>

• Renvoi du JSON complet
• Explication sur la mise à jour d'un élément dans un Widget Météo
  • Renseigner UUID et/ou nom.

/delete/<uuid>

• Envoie dans la corbeille.

/publish/<uuid>

• Publie une météo en construction

Messages d'erreurs

• Mêmes erreurs que dans l'interface ( dans la langue de l'interface )
• Même comportement que l'interface : On peut sauvegarder la vue si l'interface l'aurait autorisé.
• Code d'erreur HTTP cohérent