B2B PRISM Live Studio 개요
- 인쇄
- PDF
B2B PRISM Live Studio 개요
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
Classic/VPC 환경에서 이용 가능합니다.
B2B PRISM Live Studio에서 고객의 서비스를 연동하여 라이브 스트리밍을 송출하기 위해 필요한 API를 설명합니다.
서비스 API 정의
서비스 API는 B2B PRISM Live Studio에서 고객의 서비스를 연동하여 라이브를 송출하기 위해 서비스에서 필수적으로 제공되어야 하는 API입니다. 서비스 API에는 필수 구축 API와 선택 구축 API가 있습니다. 각 API에 대한 설명은 다음과 같습니다.
- 필수 구축 API
- B2B PRISM Live Studio 기능을 사용하기 위해 필수로 구축해야 하는 API입니다.
- 지원하지 않으면 서비스를 활성화할 수 없습니다.
- 선택 구축 API
- B2B PRISM Live Studio 추가 기능을 사용하기 위해 구축해야 하는 API입니다.
- 종류별로 제공할 수 있으며, 제공 여부는 서비스 설정 시 설정할 수 있습니다.
- API별로 의존성을 가진 다른 API가 있으며, 의존성이 있는 API는 함께 제공되어야 합니다.
서비스 API 제약 사항
B2B PRISM Live Studio API 사용 시 주의해야 할 제약 사항을 설명합니다.
- REST API
- 기본적인 연동은 REST API 를 사용합니다.
- 1s 이내의 응답 시간을 권장하며, 3s가 넘어갈 경우 정상 동작을 보장하지 않습니다.
- 인증 및 보안
- 모든 통신은 SSL을 이용한 HTTPS를 사용해야 합니다. (TLSv1.2 이상 권장)
- OAuth2.0을 통해 획득한 Access Token을 사용합니다.
서비스 API 목록
서비스 API 목록을 소개합니다.
필수 구축 API
필수 구축 API 목록은 다음과 같습니다.
| 분류 | 상세 분류 | 설명 | 스펙 |
|---|---|---|---|
| AUTH | 로그인 및 인증 | li>OAuth2.0 인증 API 명세 | |
| CHANNEL | 채널 조회 | ||
| 라이브 조회 | 채널 라이브 목록 조회 | 채널 라이브 목록 조회 API 명세 | |
| LIVE | 라이브 정보 조회 | 라이브 정보 및 상태 조회 | 라이브 상태 및 통계 조회 API 명세 |
| 라이브 생성 | 신규 라이브 생성 | 라이브 생성 API 명세 | |
| 라이브 시작 및 종료 |
선택 구축 API
선택 구축 API 목록은 다음과 같습니다.
| 분류 | 상세 분류 | 설명 | 의존성 | 스펙 |
|---|---|---|---|---|
| LIVE_CHAT_LIST | 채팅 조회 | 채팅 조회 API 명세 | ||
| LIVE_CHAT_SEND | 채팅 전송 | 채팅 전송 | LIVE_CHAT_LIST | 채팅 전송 API 명세 |
| LIVE_CHAT_DELETE | 채팅 삭제 | LIVE_CHAT_LIST | 채팅 삭제 API 명세 | |
| USER_BAN | 채팅 사용자 차단 및 해제 | LIVE_CHAT_LIST | ||
| USER_MOD | 채팅 관리자 권한 부여 및 해제 | LIVE_CHAT_LIST |
참고
B2B PRISM Live Studio API를 사용하는 구체적인 프로세스를 확인하려면 B2B PRISM Live Studio 연동 가이드를 참고해 주십시오.
API 기본 형식
API 기본 형식을 설명합니다.
요청 헤더
요청 헤더는 다음과 같습니다.
| 이름 | 타입 | 설명 |
|---|---|---|
| x-prism-client-id | String | 고객의 서비스에서 B2B PRISM Live Studio에 OAuth2.0 인증을 위해 제공하는 클라이언트 ID로 변경되지 않는 값 |
| x-prism-client-secret | String | 고객의 서비스에서 B2B PRISM Live Studio에 OAuth2.0 인증을 위해 제공하는 클라이언트 Secret으로 보안 이슈 등의 이유로 필요 시 협의를 통해 변경 가능 |
| x-prism-access-token | String | OAuth2.0 로그인 시에 발급받아 저장하여 사용하며, 매 로그인마다 변경. Access Token이 만료되었을 경우, ACCESS_TOKEN_EXPIRED(1002) 오류 발생 |
참고
요청 헤더에서 Content-type은 다음과 같습니다.
Content-type: application/json
기본 응답 형식
기본 응답 형식은 다음과 같습니다.
| 이름 | 타입 | 설명 | 필수 여부 |
|---|---|---|---|
| success | Boolean | 요청 성공 여부 | Y |
| errorCode | Number | 성공일 경우 0, 실패일 경우 API error code 참조 | Y |
| errorName | String | 성공일 경우 공백, 실패일 경우 API error code 참조 | Y |
| message | String | 자세한 오류 메시지를 제공할 경우, 더 빠른 오류 모니터링 가능 | N |
| data | Object | 성공 여부만 리턴하는 경우, data는 없어도 가능하며 각 data 형식은 API 명세 참조 | N |
API 공통 오류 코드
API 공통 오류 코드는 다음과 같습니다.
| 코드 | 코드명 | HTTP 상태 코드 | HTTP 상태 코드 메시지 | 설명 |
|---|---|---|---|---|
| 1000 | INVALID_PARAMETER | 400 | Bad Request | 요청한 path parameter 혹은 request body에 적절하지 않은 값이 있을 경우 |
| 1001 | UNAUTHORIZED_ACCOUNT_ID | 401 | Unauthorized | 유효하지 않은 account id 혹은 account token으로 호출할 경우 |
| 1011 | ACCESS_TOKEN_EXPIRED | 400 | Bad Request | Access Token이 만료되었을 경우 |
| 1012 | ACCESS_TOKEN_INVALID | 400 | Bad Request | Access Token이 유효하지 않을 경우 |
| 1102 | CHANNEL_DISABLED | 400 | Bad Request | 채널이 비활성화된 경우 |
| 1104 | RESOURCE_NOT_FOUND | 404 | Not Found | liveId, channelId, userId 등을 조회할 때, 조회하고자 하는 객체가 존재하지 않는 경우 |
| 2000 | UNEXPECTED_ERROR | 500 | Internal Server Error | 예상치 못한 서버 오류가 발생한 경우 |
이 문서가 도움이 되었습니까?