{"templateId":"markdown","versions":[{"version":"1.0","label":"1.0","link":"/products/live/live_guide","default":true,"active":true,"folderId":"7198473d"}],"sharedDataIds":{"sidebar":"sidebar-products/live/@1.0/live.sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["img"]},"type":"markdown"},"seo":{"title":"Kollus Live API 1.0 가이드","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]},"description":"Kollus Live 서비스 연동을 위한 RESTful API 공식 가이드입니다. API 인증 방식부터 예제 코드까지, 외부 시스템과의 표준화된 데이터 연동 및 개발 환경 구축을 위한 상세 스펙을 확인하세요."},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"live-api-가이드","__idx":0},"children":["Live API 가이드"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Kollus Live는 외부 시스템과의 데이터 연동을 위해 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["RESTful API"]},"를 제공합니다."," ","이 가이드에서는 요청 규격과 인증 방식을 설명합니다. 예제를 참고하여 개발 환경을 구성할 수 있습니다."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"요청-규격","__idx":1},"children":["요청 규격"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"호출-제한","__idx":2},"children":["호출 제한"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["1분당 최대 60회 호출 가능합니다. 연속 호출 시 최소 1초 이상의 간격을 유지해 주세요."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"요청-헤더","__idx":3},"children":["요청 헤더"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["HTTP Method에 따라 Accept 헤더와 Content-Type을 지정해야 합니다."]},{"$$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 헤더"},"children":["Accept 헤더"]},{"$$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":"인증-방식","__idx":4},"children":["인증 방식"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["모든 API 요청은 OAuth2 사양을 준수하며, 요청 헤더에 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Bearer Token"]},"을 포함해야 합니다."]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Kollus Live 콘솔에서 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["[설정] > [기본 정보] > ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://live-kr.kollus.com/preferences/service_account","target":"_blank","rel":"noopener noreferrer"},"children":["[서비스 계정] 탭"]}]},"으로 이동합니다."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["하단 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[Personal Access Tokens]"]}," 섹션에서 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[Create New Token]"]},"을 클릭합니다."]},{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/live_api_guide_1.a52631479ae01d520e2a0a547a0f95ed02117c1513fe49a21b75be5cc2c359e8.9c1bb791.png","alt":"Kollus Live 콘솔 화면","withLightbox":false,"width":"100%","border":"1px solid gray"},"children":[]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["토큰 이름을 입력하고 필요한 ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Scopes"]},"를 체크한 뒤 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["[저장]"]},"을 클릭합니다."]},{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/live_api_guide_2.3af5662667cf3e98554853e3887809cd983b98d3f87898ddbf2b046825173ab2.9c1bb791.png","alt":"토큰 생성 창","withLightbox":false,"width":"50%","border":"1px solid gray"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["각 API의 필요 Scope는 API 레퍼런스의 Security 항목에서 확인할 수 있습니다."]},{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/live_api_guide_4.88608721166bfdf19e21d87733d9d5ca19acb47accb3560169e7c591f867181c.9c1bb791.png","alt":"API 레퍼런스","withLightbox":false,"width":"100%","border":"1px solid gray"},"children":[]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["생성된 토큰은 보안상 이후 다시 조회할 수 없습니다. ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["토큰을 즉시 복사하여 안전한 곳에 저장"]},"하세요."]},{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/assets/live_api_guide_3.1c6cbe29eeff29ce14f43fdb36db4407ee4b3c1da9cbeda27415cd6ff7b7e950.9c1bb791.png","alt":"토큰 안내 창","withLightbox":false,"width":"50%","border":"1px solid gray"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"요청-예시","__idx":5},"children":["요청 예시"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"채널-정보-조회","__idx":6},"children":["채널 정보 조회"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"curl","header":{"controls":{"copy":{}}},"source":"curl -X GET \"https://api-live-kr.kollus.com/api/v1/live/service-accounts/{SERVICE_ACCOUNT_KEY}/channels/{CHANNEL_KEY}/broadcasts?order=id_desc&page=1&per_page=10\" -H \"accept: application/json\" -H \"Authorization: Bearer accesstoken....\"\n","lang":"curl"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"서비스-계정-역할-및-권한","__idx":7},"children":["서비스 계정 역할 및 권한"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["서비스 계정에 부여된 역할에 따라 사용 가능한 기능과 접근 범위가 달라집니다. 역할별 상세 권한은 ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.kollus.com/service-guide/live/account/service-account","target":"_blank"},"children":["서비스 계정 역할 및 권한"]}," 문서를 참고하세요."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"키key-정보","__idx":8},"children":["키(Key) 정보"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["요청 URL에 포함되는 키 정보는 ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://docs.kollus.com/dev-guide/live/quickstart/key","target":"_blank"},"children":["인증 및 주요 키"]}," 문서를 참고하세요."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"예제","__idx":9},"children":["예제"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"채널-생성-post","__idx":10},"children":["채널 생성 (POST)"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"js","header":{"controls":{"copy":{}}},"source":"// Implementation using axios\n\nimport axios from \"axios\";\n\nconst url =\n  \"https://api-live-kr.kollus.com/api/v1/live/service-accounts/{SERVICE_ACCOUNT_KEY}/channels\";\n\nconst body = new URLSearchParams({\n  title: \"test-channel\",\n  customer_code: \"catenoidtest\",\n  concurrently_viewer_limit: 100,\n  is_shared: 1,\n  live_media_profile_group_key: \"{ENCODING_PROFILE_KEY}\"\n});\n\naxios.post(url, body.toString(), {\n  headers: {\n    Accept: \"application/json\",\n    \"Content-Type\": \"application/x-www-form-urlencoded\",\n    Authorization: \"Bearer {ACCESS_TOKEN}\"\n  }\n})\n.then(response => {\n  console.log(\"Channel created successfully:\", response.data);\n})\n.catch(error => {\n  console.error(\n    \"Failed to create channel:\",\n    error.response?.data || error.message\n  );\n});\n\n","lang":"js"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"채널-내-방송-조회-get","__idx":11},"children":["채널 내 방송 조회 (GET)"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"js","header":{"controls":{"copy":{}}},"source":"// Implementation using fetch API\n\nconst url = \"https://api-live-kr.kollus.com/api\"\n+ \"/v1/live/service-accounts/{SERVICE_ACCOUNT_KEY}/channels/{CHANNEL_KEY}/broadcasts?order=id_desc&page=1&per_page=10\";\n\nfetch(url, {\n  method: \"GET\",\n  headers: {\n    \"Accept\": \"application/json\",\n    \"Authorization\": \"Bearer {ACCESS_TOKEN}\"\n  }\n})\n  .then(response => {\n    if (!response.ok) {\n      throw new Error(`HTTP error! status: ${response.status}`);\n    }\n    return response.json();\n  })\n  .then(data => {\n    console.log(\"Response Data:\", data);\n  })\n  .catch(error => {\n    console.error(\"Request failed:\", error);\n  });\n","lang":"js"},"children":[]}]},"headings":[{"value":"Live API 가이드","id":"live-api-가이드","depth":1},{"value":"요청 규격","id":"요청-규격","depth":2},{"value":"호출 제한","id":"호출-제한","depth":3},{"value":"요청 헤더","id":"요청-헤더","depth":3},{"value":"인증 방식","id":"인증-방식","depth":3},{"value":"요청 예시","id":"요청-예시","depth":3},{"value":"채널 정보 조회","id":"채널-정보-조회","depth":4},{"value":"서비스 계정 역할 및 권한","id":"서비스-계정-역할-및-권한","depth":3},{"value":"키(Key) 정보","id":"키key-정보","depth":3},{"value":"예제","id":"예제","depth":2},{"value":"채널 생성 (POST)","id":"채널-생성-post","depth":3},{"value":"채널 내 방송 조회 (GET)","id":"채널-내-방송-조회-get","depth":3}],"frontmatter":{"seo":{"title":"Kollus Live API 1.0 가이드","description":"Kollus Live 서비스 연동을 위한 RESTful API 공식 가이드입니다. API 인증 방식부터 예제 코드까지, 외부 시스템과의 표준화된 데이터 연동 및 개발 환경 구축을 위한 상세 스펙을 확인하세요."}},"lastModified":"2026-04-28T05:22:43.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/products/live/live_guide","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}