API-oversikt

Lifesize API gir et inngangspunkt basert på kommandolinje for å automatisere tilgang til og kontroll over Icon-videosystemer. API støtter en REST-metode for tilgang til et sett med ressurser eller objekter gjennom et fast sett med operasjoner. API-anrop foretas ved å sende en forespørsel til en API-ressurs og spesifisere en metode og argumenter. En formatert respons inneholder informasjon om operasjonens resultater.

Denne delen gir en introduksjon til Lifesize API. Mer detaljert dokumentasjon finner du her:

https://<videoSystemIPAddress>/docs/clish   (traditional command line interface)

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

Autentisering

De samme autentiseringsretningslinjene som håndheves i en nettleser gjelder også for API-anrop. Logg inn i Lifesize-videosystemet gjennom en SSH- eller HTTP-forbindelse over nettverket på følgende måte:

  1. Åpne en klient, for eksempel Cygwin eller Putty, og oppgi IP-adressen til Lifesize-videosystemet.
  2. Logg inn i systemet som administrator. Standard brukernavn og passord er admin.

Kommandosyntaks

Kommandoer har følgende form:

<aktør> <kommando> <parametere>

 

Bruk komma til å separere flere parametere. Vis hjelp fra en kommandomelding som følger:

hjelpViser en kort innføring i bruk av API.
Trykk på Tab-tasten på tastaturetViser en liste over aktører.
<aktør> ?Viser kommandoer for en aktør. Eksempel:

lyd ?

<aktør> < kommando> ?Viser hjelp for en kommando. Eksempel:

sysadmin gettimezone ?