개요

Kollus 전용플레이어에서 다음회차 재생URL을 획득하고자 할 때 고객사에서 정의한 Callback URL을 호출(Callback)하는 기능을 정의한 문서입니다.

Token Callback

Token callback(이하 콜백)을 사용하기 위해서는 Kollus Console의 관리 화면에서 관리자 이상의 권한을 소유한 로그인 계정으로 채널 속성에 Token 콜백 항목에 고객사에서 콜백을 응답받기 위해 정의된 URL을 등록하셔야 합니다. 콜백이 정의되지 않은 채널은 Kollus 전용플레이어에서 다음회차 재생을 위한 동작을 수행하지 않습니다. 콜백이 정의된 채널을 통해 서비스되는 콘텐츠는 콜백에 대한 응답으로 전달받은 URL을 사용하여 다음회차를 재생하기 때문에 고객사에서 정의한 콜백 URL은 항상 응답상태를 유지하셔야 원활한 서비스를 받으실 수 있습니다.

주의 사항

• 다음회차 콜백은 플레이어 호출 JWT 생성 시 next_episode 값을 true 로 설정하여 호출해주셔야 동작합니다.

  • JWT

• intro / outro 기능은 다음회차 기능을 활용하실 때에는 사용하지 않기를 권장 드립니다.

• Token 콜백 URL이 응답하지 않으면 다음회차 재생기능이 동작하지 않습니다.

Callback flow

Open

1. Kollus 설정에서 관련 정보 요청을 설정합니다.

   • Kollus는 컨텐츠 배포 단위인 채널 마다 다양한 옵션을 지정할 수 있습니다.

   • 배포하는 채널마다 Token 콜백 URL을 별도로 설정 가능합니다.

2. 동영상 재생을 위해 Video-gateway를 호출하면 컨텐츠 재생을 위한 다양한 정보를 플레이어 전달하게 되며, 이때 Token 콜백과 관련된 정보를 함께 전달합니다.

3. 고객사 콜백 서버에 다음회차 재생 정보를 요청합니다. 이때, 1번 항목에서 설정한 관련 정보를 POST 전송합니다.

4. 고객사 Token 콜백 서버는 전달받은 정보를 기초로 다음 회차정보를 생성합니다.

5. 생성된 다음 회차정보를 Json 포맷의 data를 아래 방식으로  HTTP Body에 전송합니다.

   • 전송 방식

     1. JWT Encode하여 전송합니다. 알고리즘은 HS256만 지원하며, Json 포맷의 data를 JWT의 payload에 추가하여 Encoding 하고, 헤더에 지정된 “사용자키(X-KOLLUS-USERKEY)”를 함께 전송합니다.

6. 전달받은 다음회차 재생 URL을 사용하여 다음회차 영상을 재생합니다.

Callback URL Settings

Callback에 대한 설정은 채널에서 할 수 있습니다. Callback이 필요한 채널 마다 설정해야 합니다.

예시)

Plugin option

• {CLIENT_USER_ID}

  • 사용자의 User ID 입니다.

  • MediaToken 생성시 파라미터로 입력한 사용자의 ID 정보입니다.
    이때 입력된 사용자 ID는 Kollus 시스템에서 관리되지 않고 사용자를 구분하는 Unique 정보로만 사용됩니다.

• {MEDIA_CONTENT_KEY}

  • Kollus media_content_key

• {ENCODING_PROFILE_KEY}

  • Kollus encoding profile key

• {USERVALUE0}~{USERVALUE##}

  • Video-gateway호출에 추가된 추가 정보 입니다.

  • ex) LCD={USERVALUE0}&UCD={USERVALUE4}

  • 영문,숫자 이외의 한글등의 문자열을 전달할 경우 해당 변수 전달시 UTF-8로 전달해야 합니다.

  • 특수문자(영문,숫자이외의 모든문자:한글,한자,일어등)는 반드시 UTF-8문자열을 UrlEncode된 상태로 전달되어야 합니다.

Support options

플레이어별 지원 옵션을 확인할 수 있습니다.

Request Data

Response JSON spec.

예시)

• 위 예시의 값처럼 JSON 문자열을 평문으로 응답하셔야 합니다.

• 예시의 next_url 값처럼 si 로 반드시 호출해주셔야 합니다.