Visão geral da API

A API do Lifesize oferece um ponto de entrada baseado em linha de comando para automatizar o acesso e o controle de sistemas de vídeo Icon. A API oferece suporte a um método REST para cessar um conjunto de recursos, ou objetos, através de um conjunto fixo de operações. As chamadas da API são feitas enviando uma solicitação para um recurso da API e especificando um método e os argumentos. Uma resposta formatada detalha o resultado da operação.

Esta seção oferece uma introdução à API do Lifesize. Uma documentação mais detalhada está disponível em:

https://<videoSystemIPAddress>/docs/clish   (interface tradicional de linha de comando)

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

Autenticação

As mesmas políticas de autenticação que são impostas a um navegador se aplicam às chamadas da API. Faça logon no seu sistema de vídeo Lifesize através de uma conexão SSH ou HTTP pela rede, como se segue:

  1. Abra um cliente, como Cygwin ou Putty, e insira o endereço IP do sistema de vídeo Lifesize.
  2. Faça login no sistema com credenciais de administrador. O nome de usuário e a senha padrão são admin.

Sintaxe de comando

Os comandos assumem a seguinte forma:

<ator> <comando> <parâmetros>

 

Use vírgulas para separar vários parâmetros. Acesse a ajuda a partir de um prompt de comando:

ajudaMostra uma breve introdução do uso da API.
Pressione a tecla Tab do tecladoMostra uma lista de atores.
<ator> ?Mostra os comandos para um ator. Exemplo:

audio ?

<ator> <comando> ?Mostra a ajuda para um comando. Exemplo:

sysadmin gettimezone ?