Przegląd API

API Lifesize zapewnia punkt wejścia w oparciu o wiersz polecenia w celu umożliwienia automatycznego dostępu i sterowania systemów wideo systemu Icon. API wspiera korzystanie z metody REST w zakresie dostępu do źródeł lub obiektów poprzez zapisany zestaw czynności. Połączenia API są nawiązywane poprzez wysłanie zapytania do źródła API i określenie metody i argumentów. Informacje w sformatowanej odpowiedzi określają wynik czynności.

Niniejsza część zawiera wprowadzenie do Lifesize API. Więcej szczegółowej dokumentacji znajduje się pod adresem:

https://<videoSystemIPAddress>/docs/clish (tradycyjny interfejs wiersza polecenia)

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

Uwierzytelnianie

Do połączeń API stosowane są te same zasady uwierzytelniania jak do przeglądarki. Zaloguj się do systemu wideo Lifesize przez połączenie SSH lub HTTP w sieci w sposób opisany poniżej:

  1. Otwórz klienta, np. Cygwin lub Putty i wprowadź adres IP systemu wideo Lifesize.
  2. Zaloguj się do systemu z uprawnieniami administratora. Domyślnie nazwa użytkownika i hasło ustawione są jako admin.

Składnia poleceń

Polecenia zapisywane są w następującej formie:

<aktor><polecenie><parametry>

 

Parametry oddziel przecinkami. Pokaż pomoc z monitów poleceń w następujący sposób:

pomocWyświetla krótkie wprowadzenie do korzystania z funkcji API.
Naciśnij klawisz Karta na klawiaturzeWyświetla listę aktorów.
<aktor>?Wyświetla polecenia dla aktora. Na przykład:

dźwięk?

<polecenie><aktora>?Pokaż pomoc dla polecenia. Na przykład:

sysadmin gettimezone?