API 개요

Lifesize API를 이용하면 Icon 비디오 시스템의 액세스와 제어를 명령줄에서 자동화할 수 있습니다. 이 API는 지정된 절차를 통해 일련의 리소스 또는 개체에 액세스하는 REST 방법을 지원합니다. API 통화는 API 리소스로 요청을 전송하고 메소드와 인수를 지정하는 방식으로 이루어집니다. 형식화된 응답에 작업 결과가 자세히 기술됩니다.

이 섹션에서는 Lifesize API에 대해 간략히 소개합니다. 자세한 문서는 다음 페이지에서 확인할 수 있습니다:

https://<videoSystemIPAddress>/docs/clish   (전통적인 명령줄 인터페이스)

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

인증

브라우저에 적용된 것과 동일한 인증 정책이 API 통화에도 적용됩니다. 다음과 같이 네트워크에서 SSH 또는 HTTP 연결을 통해 Lifesize 비디오 시스템에 로그인합니다.

  1. Cygwin 또는 Putty와 같은 클라이언트를 열고 Lifesize 비디오 시스템의 IP 주소를 입력합니다.
  2. 관리자 자격 증명으로 시스템에 로그인합니다. 기본 사용자 이름과 암호는 admin입니다.

명령 구문

명령의 형식은 다음과 같습니다:

<actor> <command> <parameters>

 

여러 개의 매개 변수는 쉼표로 구분합니다. 다음과 같이 명령 프롬프트에서 도움말을 표시합니다.

도움말API 사용법을 간략히 안내합니다.
키보드의 Tab 키를 누릅니다. 작업자 목록을 표시합니다.
<actor> ? 작업자에 대한 명령을 표시합니다. 예:

audio ?

<actor> <command> ? 명령에 대한 도움말을 표시합니다. 예:

sysadmin gettimezone ?