API-yleiskatsaus

Lifesize API antaa komentoriviin perustuvan tulopisteen Icon-videojärjestelmien automaattista pääsyä ja ohjausta varten. API tukee REST-menetelmää, jolla pääsee tiettyihin resursseihin tai kohteisiin kiinteän toimintosarjan kautta. API-puhelut toteutetaan lähettämällä pyyntö API-resurssiin ja määrittelemällä menetelmä ja argumentit. Formatoitu vastaus erittelee toimintojen tuloksen.

Tässä osiossa esitetään johdanto Lifesize APIn käyttöön. Lisää tarkempaa dokumentaatiota on saatavilla osoitteessa:

https://<videoSystemIPAddress>/docs/clish (perinteinen komentorivikäyttöliittymä)

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

Todentaminen

API-puheluihin sovelletaan samoja todentamiskäytäntöjä kuin ne, jotka ovat voimassa selaimille. Kirjaudu sisään Lifesize-videojärjestelmään SSH- tai HTTP-yhteyden kautta verkossa seuraavasti:

  1. Avaa ohjelma, esim. Cygwin tai Putty, ja kirjoita Lifesize-videojärjestelmän IP-osoite.
  2. Kirjaudu sisään järjestelmään järjestelmänvalvojan tunnuksin. Oletusarvoinen käyttäjänimi ja salasana on admin.

Komentosyntaksi

Komennot näkyvät seuraavassa muodossa:

<toimija> <komento> <parametrit>

 

Käytä pilkkuja useampien parametrien erottamiseen. Näytä ohje komentokehotuksesta seuraavalla tavalla:

helpNäyttää lyhyen johdatuksen APIn käyttöön.
Paina näppäimistön Tab-näppäintäNäyttää listan toimijoita.
<actor> ?Näyttää komennon toimijalle. Esimerkiksi:

audio ?

<actor> <command> ?Näyttää avun komennolle. Esimerkiksi:

sysadmin gettimezone ?