비콜로 비디오룸 웹앱에서 사용하기
플립플랍 클라우드를 사용하기 위해서는 사용자로 가입하는 단계가 선행 되어야 합니다. 하지만 현재는 정책상 문의를 통해서 가입 요청만 받고 있습니다. 플립플랍 클라우드를 가입 및 그에 따른 추후 사용 절차는 사용자 가입 및 사용 절차를 참고 바랍니다.
개요
플립플랍 클라우드는 화상회의 기능을 제공하며, 이를 여러분의 서비스에 손쉽게 통합하여 사용자들에게 화상회의 기능을 간편하게 제공할 수 있습니다.
이 문서는 iFrame을 사용하여 Vicollo의 화상회의 기능을 여러분의 웹 앱에 통합하는 방법과 통합 과정에서 적용할 수 있는 다양한 설정에 대해 안내합니다.
사전 정보
플립플랍 클라우드는 사용 목적에 따라 테스트를 위한 환경과 상업적 사용을 위한 환경이 별도로 운영 되고 있습니다. 각 환경별 정보는 다음과 같습니다.
본 문서는 테스트를 위한 설명을 목적을 두고 있기 때문에 모든 정보를 sadnbox 환경 기준으로 작성 되었습니다.
선행조건
비콜로 언매니지드 앱 생성
플립플랍 클라우드의 모든 기능은 앱이라는 단위 안에서 이루어지며 비콜로의 화상회의 기능을 여러분의 서비스에 가져다 사용하는 것은 언매니지드
형태로 동작하는 비콜로 앱
인 비콜로 언매니지드 앱
을 통해서만 가능합니다. 이 문서에서는 비콜로 언매니지드 앱
만 다루기 때문에 이하에서는 비콜로 앱
으로만 표기 합니다.
앱의 종류와 차이점에 대해서는 주요 개념 > 앱 문서의 플립플랍 클라우드 앱 종류 문서를 참고 바랍니다.
가입 문의를 통해 계정을 발급 받는 과정에서 여러분의 서비스에 비콜로를 사용하는 방법에 대한 문의를 하셨다면 계정 정보와 함께 그 계정으로 생성한 비콜로 앱
에 대한 정보가 같이 제공 됩니다. 현재는 사용자가 비콜로 앱
을 생성할 수 있는 방법이 제공되지 않아 다른 목적으로 계정 발급을 받아 생성된 비콜로 앱
이 없다면 별도로 문의를 통해 생성을 요청해야 합니다. 빠른 시일 내에 비콜로를 별다른 절차 없이 사용할 수 있도록 노력하겠습니다.
비콜로 앱 서버 API 호출하기
현재 비콜로 앱
의 관리 및 운영을 하기 위한 GUI 환경의 어드민 페이지는 개발 중에 있습니다. 따라서 현재는 운영을 API로 해야 합니다. GUI 환경의 어드민 페이지는 빠른 시일내에 사용이 가능하도록 개발하도록 노력 하겠습니다.
API 요청에 사용할 Base URL은 https://portal-sandbox.flipflop.cloud 입니다. 요청에 Authorization
헤더를 다음과 같이 지정해 줍니다.
Basic {API key/secret을 ':'를 사이에 둔 문자열을 base64 인코딩한 문자열}
서버 API는 웹/모바일 앱에서 사용하면 API key/secret이 노출되어 오남용의 문제가 발생하여 플립플랍 클라우드의 안정적인 운영 및 사용자의 금전적 피해가 발생할 수 있으니 꼭 서버에서만 사용해야 합니다.
개괄
비콜로
의 화상회의 기능을 사용하기 위한 전체적인 과정은 다음과 같은 단계로 이루어집니다.
- 멤버 생성/등록
- 비디오룸 생성
- 비디오룸 초대 URL 생성
웹앱에 비콜로 비디오룸 사용하기
1. 멤버 생성/등록
여러분의 서비스 사용자들은 Vicollo 앱에 등록되어야 합니다. 모든 사용자를 사전에 등록할 필요는 없지만, 필요할 때마다 사용자를 등록하는 것은 필수적입니다. 등록 시 가장 중요한 정보는 **appUserId
**로, 이는 여러분의 서비스에서의 고유 사용자 ID에 해당해야 합니다. Vicollo와 여러분의 서비스 간의 백엔드 통합을 쉽게 하기 위해, 사용자 이름과 같은 사람이 읽을 수 있는 식별자보다는 데이터베이스의 기본 키를 문자열 타입으로 변환한 값을 사용하는 것을 권장합니다.
또한, Vicollo 내에서 표시될 화면 이름(screen name)을 등록할 수도 있습니다. 사용자 등록 API는 사용자 정보의 지속적인 동기화를 지원합니다. 예를 들어, 사용자가 여러분의 서비스에서 화면 이름을 변경하면, **appUserId
**를 사용해 화면 이름을 업데이트하면 정보가 여러분의 서비스와 Vicollo 앱 간에 동기화됩니다.
멤버 생성/조회/수정 작업을 위한 API는 다음을 참고하십시오.
- 멤버 생성/등록 (Swagger UI / API Documentation)
- 멤버 목록 조회 (Swagger UI / API Documentation)
- 멤버 조회 (Swagger UI / API Documentation)
2. 비디오룸 생성
비디오룸(Video-room)은 소유자 또는 생성자를 가지고 있으며, 이는 Vicollo 앱의 멤버입니다. 요청 및 응답에서 소유자 또는 생성자는 Vicollo 앱 멤버 ID(appUserId
)로 지정됩니다. 만약 지정하지 않을 경우, 기본적으로 Vicollo 앱 소유자에 해당하는 멤버가 비디오룸의 소유자가 됩니다.
선택적으로 지정할 수 있는 필드로는 제목(title), 설명(description), 그리고 **예약 시간(scheduled time)**이 있습니다. 이러한 선택적 필드는 조회하거나 정보를 제공하는 데에만 사용되며, 다른 목적은 없습니다.
비디오룸 생성/조회/수정을 위한 API는 다음을 참고하십시오.
- 비디오룸 생성 (Swagger UI / API Documentation)
- 비디오룸 목록 조회 (Swagger UI / API Documentation)
- 비디오룸 조회 (Swagger UI / API Documentation)
- 비디오룸 업데이트 (Swagger UI / API Documentation)