WECANDEO API

WECANDEO API는 WECANDEO의 영상 스트리밍 서비스를 네트워크가 가능한 모든 환경에서 사용할 수 있도록 구현한 REST API입니다.

WECANDEO에서 제공하는 VIDEOPACK과 LIVEPACK 기능을 WECANDEO API를 사용하여 서비스할 수 있습니다.

🚨
주의

사용하는 API의 버전은 상품의 버전과 동일해야 합니다.

e.g., VIDEOPACK V4 → API v3.0 사용(❌), API v4.0 사용(⭕)

시작하기 전에

API KEY

WECANDEO의 API를 사용하기 위해서는 계정별로 발행되는 고유의 API Key가 필요합니다.

VIDEOPACK API Key는 VIDEO PACK 관리자 화면(CMS)의 [계정 관리 > 개발자 API] 메뉴에서 생성하기 버튼으로 API Key를 생성한 후 확인할 수 있고, LIVEPACK API Key는 LIVE PACK 관리자 화면(CMS)의 [계정 관리 > 개발자 API] 메뉴에서 확인할 수 있습니다.

비디오팩 API Key 위치

라이브팩 API Key 위치

❗️
Header 설정
[x-api-key] 헤더에 제공되는 API Key를 설정하여 호출해야 합니다.

DOMAIN 정보

API에서 사용되는 도메인 정보는 VIDEO PACK 관리자 화면(CMS)의 _[계정관리 > 도메인 > 도메인 정보]_에서 확인할 수 있습니다.

WECANDEO API 시작하기

VIDEOPACK의 업로드, 인코딩 기능을 사용하기 위해서는 동영상 폴더, 배포 패키지가 필요합니다.

동영상 폴더 생성
동영상 파일 업로드하기 전에 동영상 폴더(업로드 공간)를 생성합니다. 동영상 폴더 생성 API를 사용하여 폴더를 생성할 수 있습니다.

curl -H "x-api-key: {API Key}" https://api.v4.wecandeo.com/info/videopack/folder/v1/set/create.json?folderName={Folder Name}

{
	"createFolder":{
		"status": "Success",
		"folderId": 18
	}
}

배포 패키지 생성
배포 패키지(인코딩 공간)를 생성하여 업로드 후에 인코딩을 진행할 수 있습니다.

업로드가 완료된 후에 동영상을 ‘배포 패키지’에 추가하면 해당 패키지에 적용된 화질, 포맷 등의 설정으로 자동 인코딩됩니다.

처음 패키지 생성시에 기본 인코딩 설정이 되어 있으며, CMS에서 변경할 수 있습니다.

📘
참고

설정 변경은 WECANDEO CMS (웹) 내에서만 가능합니다.

원본이 삭제된 상태에서는 인코딩을 요청/진행할 수 없습니다.