API-overzicht

De Lifesize API heeft een toegangspunt op basis van een opdrachtregel voor het automatiseren van toegang en controle van Icon-videosystemen. De API ondersteunt een REST-methode voor toegang tot een set hulpbronnen, of objecten, via een vaste set operaties. API-oproepen worden gemaakt door een verzoek te sturen naar een API-hulpbron en een methode en argumenten te specificeren. Een geformatteerde reactie geeft informatie over de uitkomst van de operatie.

Deze sectie geeft een inleiding tot de Lifesize-API. Meer gedetailleerde documentatie is te vinden op:

https://<videoSystemIPAddress>/docs/clish   (traditionele interface met opdrachtregel)

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

Authenticatie

Het zelfde authenticatiebeleid dat wordt gehandhaafd op een browser geldt ook voor API-oproepen. Meld u als volgt aan op uw Lifesize-videosysteem via een SSH- of HTTP-verbinding over het netwerk:

  1. Open een client, zoals Cygwin of Putty, en voer het IP-adres van uw Lifesize-videosysteem in.
  2. Meld u aan bij het systeem met de inloggegevens van de administrator. De standaard gebruikersnaam en wachtwoord zijn admin.

Opdrachtsyntaxis

Opdrachten hebben de volgende vorm:

<actor> <opdracht> <parameters>

 

Gebruik komma's om meerdere parameters te scheiden. Geef op de volgende manier hulp weer vanaf een opdrachtregel:

help Toont een korte inleiding tot het gebruik van de API.
Druk op de Tab-toets op uw toetsenbord Toont een lijst met actors.
<actor> ? Toont opdrachten voor een actor. Bijvoorbeeld:

audio ?

<actor> <opdracht> ? Toont hulp voor een opdracht. Bijvoorbeeld:

sysadmin gettimezone ?