Обзор API

API компании Lifesize включает точку ввода команд командной строки для автоматического доступа и управления видеосистемами Icon. API поддерживает метод REST для доступа к ресурсам, или объектам, посредством фиксированного набора операций. Вызовы API выполняются путем отправки запросов на ресурс API с указанием метода и аргументов. В результате операции будет получен форматированный ответ.

Этот раздел содержит введение в API Lifesize. Подробная документация доступна на странице:

https://<videoSystemIPAddress>/docs/clish (обычный интерфейс командной строки)

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

Проверка подлинности

Для вызовов API действуют те же правила проверки подлинности, что и в браузере. Войдите в видеосистему Lifesize через соединение SSH или HTTP по сети следующим образом.

  1. Откройте клиент, такой как Cygwin или Putty, и введите IP-адрес своей видеосистемы Lifesize.
  2. Войдите в систему с правами администратора. Имя пользователя и пароль по умолчанию — admin.

Синтаксис команд

Команды имеют следующий вид:

<программа-агент> <команда> <параметры>

 

Для разделения нескольких параметров используйте запятые. Вызвать справку из командной строки можно следующим образом.

справкаВызов краткого введения в использование API.
Нажмите на клавишу «Табуляция» на клавиатуре.Отображение списка программ-агентов.
<actor> ?Отображение команд для программы-агента. Например:

audio ?

<actor> <command> ?Вызов справки для команды. Например:

sysadmin gettimezone ?