본문으로 건너뛰기

VOD API 가이드

Kollus VOD는 외부 시스템과의 표준화된 데이터 연동을 위해 RESTful API를 제공합니다.

이 문서를 통해 요청 규격과 인증 방식을 이해하고, Node.js 예제를 참고하여 개발 환경을 구성할 수 있습니다.

Kollus VOD API 레퍼런스​

상세한 엔드포인트 정보와 파라미터 규격은 아래 문서를 참고하세요.

요청 규격​

요청 헤더​

HTTP Method에 따라 적절한 Accept 헤더와 Content-Type을 설정해야 합니다.

HTTP MethodAccept 헤더Content-Type
GET / DELETEapplication/json-
POST / PUTapplication/jsonapplication/x-www-form-urlencoded

인증 방식​

모든 API 요청은 인증 토큰(kollus_api_access_token)을 포함해야 합니다.

  • 토큰 위치: Kollus VOD 콘솔 > [서비스 계정] > [API]

    ⚠️주의

    새로운 토근을 발급하는 즉시 기존 토큰은 무효화됩니다. 운영 중인 시스템일 경우 서비스 중단이 발생할 수 있습니다.

    API 화면

요청 URL 구성 예시​

채널 정보 조회​

https://c-api-kr.kollus.com/api/channels/{channel_key}?access_token={access_token}

API 호출에 필요한 각종 식별 키 정보는 서비스 연동 키 문서를 참고하세요.

Node.js 예제​

패키지 설치​

연동에 필요한 라이브러리를 설치합니다.

$ npx api install "@kollus-vod/v3.0-KR#189zaiumejg7t49"

채널 생성(POST)​

신규 채널 생성을 위한 필수 정보를 전송합니다.

import kollusVod from '@api/kollus-vod';

// 인증 설정
kollusVod.auth('{kollus_api_access_token}');

// 채널 생성 실행
kollusVod._9c1ead997f8db167ade85da30910a14c({
  name: 'new_channel_name',
  description: 'new_channel_description',
  is_shared: 0,
  is_encrypted: 0
})
  .then(({ data }) => console.log(data))
  .catch(err => console.error(err));

채널 정보 조회(GET)​

채널 키를 파라미터로 전달하여 상세 데이터를 수신합니다.

import kollusVod from '@api/kollus-vod';

// 인증 설정
kollusVod.auth('{kollus_api_access_token}');

// 특정 채널 조회
kollusVod._7af1e384be9287f26a99c03a3b8eb2bb({channel_key: '{channel_key}'})
  .then(({ data }) => console.log(data))
  .catch(err => console.error(err));