API の概要

Lifesize API は、ビデオ システムのアクセスと制御を自動化するためのコマンドライン ベースのエントリ ポイントを提供します。API は、操作の固定セットを使用し、リソースまたはオブジェクトにアクセスするための REST メソッドをサポートしています。API の呼び出しは、API リソースに要求を送信し、メソッドと引数を指定することによって行われます。フォーマットされた応答は、操作の結果を詳しく示します。

ここでは、Lifesize API について説明します。詳細なマニュアルは、次の Web サイトで提供されています。

https://<videoSystemIPAddress>/docs/clish(従来のコマンド ライン インターフェイス)

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

認証

ブラウザで強制されているものと同じ認証ポリシーが API の呼び出しに適用されます。次のように、ネットワークを介した SSH または HTTP 接続を使用し、Lifesize ビデオ システムにサインインします。

  1. Cygwin や Putty などのクライアントを開き、Lifesize ビデオ システムのIPアドレスを入力します。
  2. 管理者のサインイン情報でシステムにサインインします。デフォルトのユーザー名とパスワードは、admin です。

コマンド構文

コマンドは、次の形式となります。

<actor> <command> <parameters>

 

複数のパラメータを入力する場合はカンマで区切ります。次のようにコマンド プロンプトからヘルプを表示します。

helpAPIを使用するための簡単な説明が表示されます。
キーボードの Tab キーを押すアクターのリストを示します。
<actor> ? アクターのコマンドを示します。例:

audio ?

<actor> <command> ? コマンドのヘルプを表示します。例:

sysadmin gettimezone ?