{"templateId":"markdown","versions":[{"version":"3.0","label":"3.0","link":"/en/products/vod/vod_guide","default":true,"active":true,"folderId":"cba2a0c4"}],"sharedDataIds":{"sidebar":"sidebar-@l10n/en/products/vod/@3.0/vod.sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["img"]},"type":"markdown"},"seo":{"title":"Kollus VOD API v3 Guide","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]},"description":"The official guide for RESTful API integration with Kollus VOD service. Find detailed specifications for standardized data integration with external systems and development environment setup, from API authentication methods to Node.js example code."},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"vod-api-guide","__idx":0},"children":["VOD API Guide"]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["⚠️ 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."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Kollus VOD provides a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"request-specifications","__idx":1},"children":["Request Specifications"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"rate-limit","__idx":2},"children":["Rate Limit"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A maximum of 60 calls per minute is allowed. Please maintain a minimum interval of at least 1 second between consecutive calls."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"request-headers","__idx":3},"children":["Request Headers"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Accept header and Content-Type must be specified according to the HTTP Method."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"HTTP Method"},"children":["HTTP Method"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Accept Header"},"children":["Accept Header"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Content-Type"},"children":["Content-Type"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/json"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["-"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST"]}," / ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["PUT"]}]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/json"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["application/x-www-form-urlencoded"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"authentication-method","__idx":4},"children":["Authentication Method"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All API requests must include an authentication token (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["kollus_api_access_token"]},")."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Token location"]},": Kollus VOD Console > [Service Account] > ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://c-kr.kollus.com/service-account/api-service","target":"_blank","rel":"noopener noreferrer"},"children":["[API]"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note"]},": Issuing a new token immediately invalidates the existing token. Re-issuing a token on a live system may cause service interruption."]},{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/vod_api_guide_1.5e8314ceb88f0a47be9a5712f756aaa3bd8c2cf559d44438d145725095b7faf1.9c1bb791.png","alt":"Kollus VOD Console screen","framed":false,"withLightbox":false,"width":"100%","border":"1px solid gray"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"request-url-structure","__idx":5},"children":["Request URL Structure"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Pass the authentication token as a Query String after the API endpoint."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"channel-information-retrieve-example","__idx":6},"children":["Channel Information Retrieve Example"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"https://c-api-kr.kollus.com/api/channels/{CHANNEL_KEY}?access_token={KOLLUS_API_ACCESS_TOKEN}\n"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"key-information","__idx":7},"children":["Key Information"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For key information included in the request URL, refer to the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.kollus.com/en/dev-guide/vod/quickstart/key","target":"_blank"},"children":["Authentication and Key Reference"]}," document."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"nodejs-integration-example","__idx":8},"children":["Node.js Integration Example"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"package-installation","__idx":9},"children":["Package Installation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Install the library with the following command."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"$ npx api install \"@kollus-vod/v3.0-KR#189zaiumejg7t49\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"create-channel-post","__idx":10},"children":["Create Channel (POST)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create a new channel and configure key properties such as encryption settings."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"js","header":{"controls":{"copy":{}}},"source":"import kollusVod from '@api/kollus-vod';\n\n// Configure authentication\nkollusVod.auth('{KOLLUS_API_ACCESS_TOKEN}');\n\n// Execute channel creation\nkollusVod._9c1ead997f8db167ade85da30910a14c({\n  name: 'new_channel_name',\n  description: 'new_channel_description',\n  is_shared: 0,\n  is_encrypted: 0\n})\n  .then(({ data }) => console.log(data))\n  .catch(err => console.error(err));\n","lang":"js"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"retrieve-channel-information-get","__idx":11},"children":["Retrieve Channel Information (GET)"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Retrieve detailed data for a specific channel using the channel key."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"js","header":{"controls":{"copy":{}}},"source":"import kollusVod from '@api/kollus-vod';\n\n// Configure authentication\nkollusVod.auth('{KOLLUS_API_ACCESS_TOKEN}');\n\n// Retrieve specific channel details\nkollusVod._7af1e384be9287f26a99c03a3b8eb2bb({channel_key: '{CHANNEL_KEY}'})\n  .then(({ data }) => console.log(data))\n  .catch(err => console.error(err));\n","lang":"js"},"children":[]}]},"headings":[{"value":"VOD API Guide","id":"vod-api-guide","depth":1},{"value":"Request Specifications","id":"request-specifications","depth":2},{"value":"Rate Limit","id":"rate-limit","depth":3},{"value":"Request Headers","id":"request-headers","depth":3},{"value":"Authentication Method","id":"authentication-method","depth":3},{"value":"Request URL Structure","id":"request-url-structure","depth":3},{"value":"Channel Information Retrieve Example","id":"channel-information-retrieve-example","depth":4},{"value":"Key Information","id":"key-information","depth":3},{"value":"Node.js Integration Example","id":"nodejs-integration-example","depth":2},{"value":"Package Installation","id":"package-installation","depth":3},{"value":"Create Channel (POST)","id":"create-channel-post","depth":3},{"value":"Retrieve Channel Information (GET)","id":"retrieve-channel-information-get","depth":3}],"frontmatter":{"seo":{"title":"Kollus VOD API v3 Guide","description":"The official guide for RESTful API integration with Kollus VOD service. Find detailed specifications for standardized data integration with external systems and development environment setup, from API authentication methods to Node.js example code."}},"lastModified":"2026-07-21T04:58:00.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/en/products/vod/vod_guide","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}