API-Übersicht

Die Lifesize-API enthält eine auf Befehlszeilen basierende Eingabeoption für den automatischen Zugriff auf und die Steuerung von Icon-Videosystemen. Die API unterstützt eine REST-Methode für den Zugriff auf eine Reihe von Ressourcen oder Objekten über eine festgelegte Vorgangsreihe. API-Anrufe werden durch Senden einer Anfrage an eine API-Ressource und Festlegen von Argumenten und einer Methode getätigt. Eine formatierte Antwort enthält die Details des Vorgangsergebnisses.

Dieser Abschnitt enthält eine Einführung in die Lifesize-API. Eine vollständige Dokumentation ist verfügbar unter:

https://<videoSystemIPAddress>/docs/clish   (herkömmliche Befehlszeilenschnittstelle)

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

Authentifizierung

Dieselben Authentifizierungsrichtlinien, die auf einem Browser gelten, gelten auch für API-Anrufe. Melden Sie sich über eine SSH- oder HTTP-Verbindung wie folgt über das Netzwerk bei Ihrem Lifesize-Videosystem an:

  1. Öffnen Sie einen Client, z. B. Cygwin oder Putty, und geben Sie die IP-Adresse Ihres Lifesize-Videosystems ein.
  2. Melden Sie sich mit Administratoranmeldeinformationen bei dem System an. Der Benutzername und das Kennwort lauten standardmäßig admin.

Befehlssyntax

Befehle weisen das folgende Format auf:

<actor> <command> <parameters>

 

Verwenden Sie Kommas, um mehrere Parameter voneinander zu trennen. Zeigen Sie die Hilfe wie folgt von einer Eingabeaufforderung an:

HilfeZeigt eine kurze Einführung in die Verwendung der API.
Drücken Sie die Tab-Taste auf Ihrer Tastatur.Zeigt eine Liste der Akteure an.
<actor> ?Zeigt Befehle für einen Akteur an. Beispiel:

Audio ?

<actor> <command> ?Zeigt Hilfe für einen Befehl an. Beispiel:

sysadmin gettimezone ?