Panoramica API

L'API Lifesize fornisce un punto di inserimento basato sulla riga di comando per automatizzare l'accesso e il controllo dei sistemi video Icon. L'API supporta un metodo REST per accedere a un set di risorse, o oggetti, attraverso un insieme fisso di operazioni. Le chiamate API vengono eseguite inviando una richiesta a una risorsa API e specificando un metodo e gli argomenti. Una risposta formattata fornisce i dettagli sul risultato dell'operazione.

Questa sezione fornisce un'introduzione all'API Lifesize. Una documentazione più dettagliata è disponibile sul sito:

https://<videoSystemIPAddress>/docs/clish   (interfaccia della riga di comando tradizionale)

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

Autenticazione

Gli stessi criteri di autenticazione applicati a un browser vengono applicati anche alle chiamate API. Accedere al sistema video Lifesize tramite un collegamento SSH o HTTP sulla rete come segue:

  1. Aprire un client, ad esempio Cygwin o Putty, e inserire l'indirizzo IP del proprio sistema video Lifesize.
  2. Accedere al sistema con le credenziali di amministratore. Il nome utente e la password predefiniti sono admin.

Sintassi dei comandi

I comandi assumono il seguente formato:

<actor> <comando> <parametri>

 

Usare le virgole per separare più parametri. Visualizzare l'help da un prompt di comando come segue:

helpMostra una breve introduzione all'uso di API.
Premere il tasto Tab sulla tastieraMostra un elenco di actor.
<actor> ?Mostra i comandi di un actor. Ad esempio:

audio ?

<actor> <comando> ?Mostra l'help di un comando. Ad esempio:

sysadmin gettimezone ?