VOD API Guide

⚠️ This document is a machine-translated draft and is currently undergoing review. Some content may be inaccurate or differ from the original Korean version. For the most precise information, please refer to the Korean documentation.

Kollus VOD provides a RESTful API for data integration with external systems. This guide explains the request specifications and authentication methods. You can set up your development environment by referencing the Node.js integration examples.

A maximum of 60 calls per minute is allowed. Please maintain a minimum interval of at least 1 second between consecutive calls.

The Accept header and Content-Type must be specified according to the HTTP Method.

All API requests must include an authentication token (kollus_api_access_token).

• Token location: Kollus VOD Console > [Service Account] > [API]

• Note: Issuing a new token immediately invalidates the existing token. Re-issuing a token on a live system may cause service interruption.

  

Pass the authentication token as a Query String after the API endpoint.

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

For key information included in the request URL, refer to the Authentication and Key Reference document.

Install the library with the following command.

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

Create a new channel and configure key properties such as encryption settings.

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

// Configure authentication
kollusVod.auth('{KOLLUS_API_ACCESS_TOKEN}');

// Execute channel creation
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));

Retrieve detailed data for a specific channel using the channel key.

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

// Configure authentication
kollusVod.auth('{KOLLUS_API_ACCESS_TOKEN}');

// Retrieve specific channel details
kollusVod._7af1e384be9287f26a99c03a3b8eb2bb({channel_key: '{CHANNEL_KEY}'})
  .then(({ data }) => console.log(data))
  .catch(err => console.error(err));