Přehled API

API Lifesize umožňuje zadávání prostřednictvím příkazového řádku pro automatizaci přístupu a ovládání videosystémů Icon. API podporuje metodu REST pro přístup k sadě zdrojů nebo objektů na základě pevné sady operací. Hovory API se provádějí odesláním požadavku na zdroj API a specifikací metody a argumentů. Formátovaná odpověď obsahuje podrobnosti o výstupu operace.

Tato část obsahuje úvod do API Lifesize. Podrobnější dokumentace je k dispozici na adrese:

https://<videoSystemIPAddress>/docs/clish   (tradiční rozhraní příkazového řádku)

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

Autentizace

Stejné zásady autentizace, které jsou prosazovány v prohlížeči, se vztahují i na hovory API. Přihlaste se do svého video systému Lifesize přes SSH nebo HTTP připojení přes síť takto:

  1. Otevřete klienta, jako je například Cygwin nebo Putty a zadejte IP adresu vašeho video systému Lifesize.
  2. Přihlaste se do systému s pověřením správce. Výchozí uživatelské jméno a heslo je admin.

Syntaxe příkazu

Příkazy mají následující podobu:

<účastník> <příkaz> <parametry>

 

K oddělení více parametrů použijte čárky. Nápovědu z příkazového řádku si zobrazíte takto:

Nápověda Zobrazí krátký úvod do používání API.
Stisknutím klávesy TAB na klávesnici se zobrazí seznam účastníků.
<účastník> ? Zobrazí příkaz pro účastníka. Například:

zvuk ?

<účastník> <příkaz> ? Zobrazí nápovědu pro příkaz. Například:

sysadmin gettimezone ?