B2B PRISM Live Studio 연동 개요

Classic/VPC 환경에서 이용 가능합니다.

B2B PRISM Live Studio를 이용하려면 고객의 서비스에 이 가이드에서 제공하는 스펙에 따라 필요한 API(서비스 API)를 구축해야 합니다.

서비스 API 구축이 필요한 이유

서비스 API는 B2B PRISM Live Studio에서 고객의 서비스로 라이브를 송출하기 위해 필요한 정보를 주고 받는 게이트웨이 역할을 합니다. 따라서 고객의 서비스에서 반드시 스펙에 맞게 API를 구축하고 안정적으로 운영해야 정상적인 연동이 가능합니다.

신규 라이브 생성 및 라이브 정보 조회

B2B PRISM Live Studio는 고객의 서비스에 새로운 라이브를 생성하고 라이브의 정보를 조회하여 송출을 시작할 수 있어야 합니다. 고객의 서비스는 B2B PRISM Live Studio에서 라이브를 송출하려면 필요한 송출 경로 (<예시> RTMP URL) 등의 정보를 서비스 API를 통해 전달해 주어야 합니다.

라이브 상태 확인

B2B PRISM Live Studio는 라이브의 현재 상태를 주기적으로 확인합니다. 고객의 서비스에서 특정 라이브의 송출을 강제로 종료하거나 차단할 경우 B2B PRISM Live Studio에서도 라이브의 상태를 스트리머에게 알리고 라이브를 종료합니다.

라이브 메트릭 수집

스트리머는 B2B PRISM Live Studio를 통해 현재 진행 중인 라이브의 시청자 수, 좋아요 수, 채팅 수 등의 메트릭 정보를 수집 및 스트리머에게 전달할 수 있습니다.

기타 기능 연동

고객의 서비스는 라이브에 필요한 부가 기능을 API 형태로 B2B PRISM Live Studio에 제공하여 스트리머에게 방송의 편의를 제공할 수 있습니다. 제공되는 부가기능은 다음과 같습니다.

• 채팅 전송 및 조회
• 채팅 사용자 차단 및 해제
• 채팅 관리자 등록 및 해제

서비스 API 사용 방법

B2B PRISM Live Studio의 서비스 API는 기본 규격과 보안 가이드에 맞춰 구축해야 합니다.

REST API 사용

REST API 사용 시 다음을 주의해 주십시오.

• 서비스 API는 REST API의 규격을 따릅니다.
• GET/POST/PUT/DELETE methods를 사용합니다.
  • OPTIONS/HEAD method는 보안상의 이슈로 절대로 외부에 제공되어서는 안됩니다.
• 요청하는 채널, 라이브 정보가 없을 경우 HTTP status로 200 OK와 Empty Body가 아닌 반드시 404 Not Found를 제공해야 합니다.
• 채널 등 리소스의 목록을 요청하는 경우 반드시 수정 시간의 역순 → 생성 시간의 역순으로 제공되어야 합니다.

보안 및 인증

모든 서비스 API는 보안을 위해 TLSv1.2 이상 SSL 연결을 통해 제공되어야 합니다. 서비스 API의 권한은 OAuth2.0 인증을 통해 제공되어야 합니다.

• B2B PRISM Live Studio는 고객의 서비스에서 제공하는 OAuth2.0 인증을 사용하여 서비스 API의 접근 권한을 가진 Access Token을 획득하고, 이를 이용하여 서비스 API를 호출합니다.
• 고객은 OAuth2.0 인증 체계를 위해 고객의 서비스를 등록할 때 다음의 정보를 등록해야 합니다.
  • client-id: OAuth2.0 서버가 클라이언트 어플리케이션을 식별하는 데 사용되는 공개적으로 알려진 문자열입니다.
  • client-secret: OAuth2.0 서버가 client-id와 함께 클라이언트의 신원을 확인하는 데 사용하는 비밀번호입니다.
• B2B PRISM Live Studio는 OAuth2.0 인증을 통해 다음의 정보를 획득합니다.
  • Access Token: 클라이언트가 사용자를 대신하여 리소스 서버와 상호 작용하는 데 사용하는 문자열입니다.
  • Refresh Token: Refresh Token은 Access Token이 만료된 후 새로운 Access Token을 받기 위해 사용합니다.
• OAuth2.0 연동에 대한 자세한 사항은 OAuth2.0 기본 개념 및 연동 가이드를 참조하시기 바랍니다.

필수 구축 API와 선택 구축 API

고객의 서비스에서 구축해야 하는 서비스 API에는 B2B PRISM Live Studio의 기능을 이용하기 위해 필수로 구축해야 하는 필수 구축 API와 추가 기능 사용을 위한 선택 구축 API가 있습니다.

필수 구축 API

필수 구축 API 명세는 다음 내용을 확인해 주십시오.

선택 구축 API

선택 구축 API 명세는 다음 내용을 확인해 주십시오.