기본 Callback
개요
Kollus 서비스를 이용 중 진행 상황은 직접 CMS를 통해서 확인할 수 있습니다. 다만, 편의를 위해 각 진행 상황마다 사전에 설정된 고객사의 Web URL로 진행 상황을 전송하고 있습니다.
이것을 Kollus Callback 서비스라고 부릅니다. 또한, 고객사의 Web URL로 Callback 전송이 실패했을 때 재시도합니다.
각 재시도 마다 내부적으로 로그를 기록하여 모든 재시도가 실패할 때에는 문제가 된 Callback 전송의 원인을 파악하고 정상적으로 Callback을 전송할 수 있도록 하고 있습니다.
본 문서는 Callback 전송과 재시도에 관한 Kollus Callback 전송서버의 처리 과정에 대해서 설명합니다.
Callback 설정
Callback 설정은 채널과 관련된 부분의 설정은 관리자 권한을 가진 사용자가 해당 채널의 운영정책 설정 화면에서 지정할 수 있으며,
기타 Callback은 Kollus 서비스 담당자에게 설정을 요청하여야 합니다.
채널 Callback 설정 (채널 컨텐츠 추가, 삭제)
상위 메뉴에서 채널을 선택합니다.
생선된 채널의 속성 수정을 선택합니다.
채널 속성 편집화면에서 채널 운영 정책을 선택합니다.
콜백 사용을 “활성화” 합니다.
필요한 채널 콜백을 등록합니다.
기타 Callback 설정 (업로드 완료, 트랜스코딩 완료, 컨텐츠 업데이트)
Kollus 서비스 담당자에게 별도 요청해 주십시오.
Callback 전송 처리
전송방법
모든 Callback은 고객사가 설정한 Web URL의 POST 방식을 사용하여 전달합니다.
모든 Callback은 전송 시점이 되면 즉시 전달하는 것을 원칙으로 합니다. (다만, Callback을 처리하는 서버의 상황이 몹시 분주한 경우 지연될 수 있습니다.)
고객사 웹서버는 Callback을 성공적으로 전달 받았을 경우 200 HTTP Status Code로 응답해야 합니다. 이때 HTTP body 부분은 확인하지 않습니다. (200이 아닌 코드로 응답할 경우 전송 실패로 간주하고 지정된 시간 후에 재시도 합니다.)
유의사항
고객사 서버는 Kollus의 Callback 전송 요청에 대해 2초 이내 연결이 수립되어야 하며, 연결이 수립된 이후 3초 내에 응답해야 합니다. 이 시간 내에 연결이 수립되지 않거나 응답하지 않는다면,
Kollus Callback 전송서버는 전송 실패로 간주하고 지정된 시간 후에 재시도 합니다. (Connect Timeout 2초, Response Timeout 3초)
시나리오
Callback 전송 재시도 처리
전송방법
기본적인 전송 방법은 “Callback 전송 처리” 항목과 동일합니다.
재시도는 5분 간격으로 최대 3번까지 시도합니다.
유의사항
고객사 서버는 Kollus의 Callback을 정상 처리했다고 간주하여 200 HTTP Status Code로 응답했다고 하여도, Connect/Response Timeout을 넘겨서 이미 Kollus Callback 전송 서버가 요청을 실패로 처리하였다면, Callback 요청이 재시도될 수 있습니다. 즉, Timeout으로 인한 동일한 Callback이 요청될 수 있으니 Callback URL 개발시 대비해야 합니다.
시나리오
Callback 전송 파라미터
업로드 완료 Callback
POST | Data type | 비고 |
---|---|---|
content_provider_key | string | 고객사의 서비스 계정 키 입니다. |
full_filename | string | 폴더를 포함한 업로드된 파일명입니다. |
filename | string | 업로드 된 파일명입니다. |
upload_file_key | string | 업로드 파일 키 |
트랜스코딩 완료 Callback
POST | Data type | 비고 |
---|---|---|
content_provider_key | string | 고객사의 서비스 계정 키 입니다. |
filename | string | 폴더를 포함한 업로드된 파일명입니다. |
upload_file_key | string | 업로드 파일 키 |
transcoding_result | string | 트랜스코딩 결과 (success, fail) |
채널 컨텐츠 추가 완료 Callback
POST | Data type | 비고 |
---|---|---|
content_provider_key | string | 고객사의 서비스 계정 키 입니다. |
full_filename | string | 폴더를 포함한 업로드 된 파일명입니다. |
filename | string | 업로드 된 파일명입니다. |
upload_file_key | string | 업로드 파일 키 |
media_content_key | string | 미디어 컨텐츠 키. 동영상 재생을 위해 채널에 할당된 컨텐츠를 식별하기 위한 키. |
channel_key | string | 콘텐츠가 할당된 채널의 식별 키 |
channel_name | string | 콘텐츠가 할당된 채널의 이름 |
profile_key | string | 콘텐츠가 트랜스코딩된 프로파일 명. 하나 이상일 경우는 ‘|’를 구분자로 하여 표현합니다. |
update_type | string | 업데이트 종류 |
채널 컨텐츠 삭제 완료 Callback
POST | Data type | 비고 |
---|---|---|
content_provider_key | string | 고객사의 서비스 계정 키 입니다. |
full_filename | string | 폴더를 포함한 업로드 된 파일명입니다. |
filename | string | 업로드 된 파일명입니다. |
upload_file_key | string | 업로드 파일 키 |
media_content_key | string | 미디어 컨텐츠 키. 동영상 재생을 위해 채널에 할당된 컨텐츠를 식별하기 위한 키. |
channel_key | string | 콘텐츠가 할당된 채널의 식별 키 |
channel_name | string | 콘텐츠가 할당된 채널의 이름 |
update_type | string | 업데이트 종류 |
컨텐츠 업데이트 Callback
POST | Data type | 비고 |
---|---|---|
content_provider_key | string | 고객사의 서비스 계정 키 입니다. |
full_filename | string | 폴더를 포함한 업로드 된 파일명입니다. |
filename | string | 업로드 된 파일명입니다. |
upload_file_key | string | 업로드 파일 키 |
update_type | string | 업데이트 종류 |
Copyright © CATENOID, lnc. All Rights Reserved.
E-mail. support@catenoid.net | Tel. 1544-4367