API-översikt

Lifesize-API:n har inmatning via kommandorad för automatisering av åtkomst och styrning av Icon-videosystem. API:n stödjer en REST-metod för åtkomst av en uppsättning resurser eller objekt genom en fast uppsättning åtgärder. API-anrop görs genom att skicka en begäran till en API-resurs och ange metod och argument. Ett formaterat svar beskriver åtgärdens resultat.

I det här avsnittet ges en introduktion till Lifesize-API:n. Närmare information finns på:

https://<videoSystemIPAddress>/docs/clish   (traditionellt kommandoradsgränssnitt)

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

Autentisering

Samma autentiseringspolicyer som finns för webbläsare gäller också API-anrop. Logga in till Lifesize-videosystemet genom en SSH- eller HTTP-anslutning över nätverket så här:

  1. Öppna en klient, exempelvis Cygwin eller Putty, och ange IP-adressen för Lifesize-videosystemet.
  2. Logga in till systemet med administratörskontot. Förvalt användarnamn och lösenord är admin.

Kommandosyntax

Kommandon har följande form:

<aktör> <kommando> <parametrar>

 

Använd kommatecken för att separera flera parametrar. Visa hjälp från en kommandotolk så här:

helpVisar en kort introduktion till hur man använder API:n.
Tryck på tabbtangenten på tangentbordetVisar en lista med aktörer.
<actor> ?Visar kommandon för en aktör. Exempel:

audio ?

<actor> <command> ?Visar hjälp för ett kommando. Exempel:

sysadmin gettimezone ?