Aperçu de l'interface API

L'API de Lifesize fournit un point d'entrée basé sur la ligne de commande pour automatiser l'accès et le contrôle des systèmes vidéo Icon. L'API prend en charge une méthode REST pour accéder à un ensemble de ressources ou d'objets, grâce à un ensemble fixe d'opérations. Les appels API sont passés en envoyant une requête à une ressource API et en spécifiant une méthode et des arguments. Une réponse formatée détaille le résultat de l'opération.

Cette section fournit une introduction à l'API de Lifesize. Une documentation plus détaillée est disponible à l'adresse suivante :

https://<videoSystemIPAddress>/docs/clish   (interface de ligne de commande traditionnelle)

https://<videoSystemIPAddress>/docs/json   (API REST)

Authentification

Les règles d'authentification qui sont appliquées sur un navigateur s'appliquent également aux appels API. Ouvrez une session dans votre système vidéo Lifesize par le biais d'une connexion SSH ou HTTP sur le réseau, de la manière suivante :

  1. Ouvrez un client, comme Cygwin ou Putty, et saisissez l'adresse IP de votre système vidéo Lifesize.
  2. Ouvrez une session dans le système avec les informations d'identification d'administrateur. Le nom d'utilisateur et le mot de passe par défaut est admin.

Syntaxe de la commande

Les commandes prennent la forme suivante :

<acteur> <commande> <paramètres>

 

Utilisez des virgules pour séparer les différents paramètres. Affiche l'aide à partir d'une invitation de commande comme ci-dessous :

aideMontre une brève introduction à l'utilisation de l'API.
Appuyez sur la touche Tab de votre clavier.Montre une liste d'acteurs.
<acteur> ?Montre les commandes pour un acteur. Par exemple :

audio ?

<acteur> <commande> ?Montre l'aide pour une commande. Par exemple :

sysadmin gettimezone ?