CMS API 알림

이 항목에서는CMS API알림에 대해 알아봅니다. 계정 사용자가 변경했든CMS API Video Cloud 시스템에서 변경했든 관계없이 계정에 있는 비디오가 변경되면 알림을 받을 수 있습니다.

개요

비디오 라이브러리에서video-change이벤트가 발생하면 알림을 받을 수 있습니다. 지정한 URL로 알림이 전송되며, 이 URL은HTTPPOST요청을 처리할 수 있는 애플리케이션을 가리켜야 합니다.

인증

CMS API에 대한 모든 요청과 마찬가지로 알림 구독을 설정하거나 나열하기 위한 요청은액세스 토큰을 사용하여 인증해야 합니다 . 액세스 토큰을 가져오는 데 사용되는 클라이언트 자격 증명에는 다음에 대한 권한이 있어야 합니다. video-cloud/notifications/all ( CMS->Notifications당신이 사용하는 경우스튜디오 UI자격 증명을 생성합니다.)

설정

새 구독을 만들려면POST요청하다https://cms.api.brightcove.com/v1/accounts/{account_id}/subscriptions알림을 전달할 엔드포인트를 포함한 요청 본문 및video-change또는master-video-change이벤트 배열의 단일 항목으로. 이벤트당 최대 10개의 엔드포인트를 지정하여 알림을 받을 수 있습니다.

에서 사용할 수video-change있는 이벤트는 동영상master-video-change라이브러리용이며, 이제 의 이벤트는 동적 전달 마스터 비디오의 자산 변경에 대한 것이며, 이는 결국 공유 비디오에 반영됩니다.

video-change이벤트용

{
  "endpoint":"https://solutions.brightcove.com/bcls/di-api/di-callbacks.php",
  "events":["video-change"]
}

master-video-change이벤트용

{
  "endpoint":"https://solutions.brightcove.com/bcls/di-api/di-callbacks.php",
  "events":["master-video-change"]
}

알림은 JSON 형식으로 전송됩니다. 다음은video-change이벤트의 예입니다.

{
  "timestamp":1423840514446, 
  "account_id":"775205503001", 
  "event":"video-change", 
  "video":"4020894387001", 
  "version":26,
  “action”:”UPDATE”,
  “updated_by”:{ "email": "string", "id": "string", "type": "user" }
}

예제는master-video-change다음과 같습니다.

{
  "timestamp":1423840514446,
  "account_id":"775205503001",
  "event":"video-change",
  "video":"4020894387001", 
  "version":26, 
  "action":"UPDATE", 
  "updated_by":{ "email": "string", "id": "string", "type": "user" },
  "master_account_id":"784205904003",
  "master_video_id":"6200985429005"
}

알림 필드

아이템 설명
timestamp 이벤트가 발생한 시간 ( Epoch밀리초)
account_id Video Cloud계정 ID
master_account_id 그만큼 Only for master-video-change events: The id of the master video who made the update in the assets shared with the affiliate video.
master_video_id 그만큼 Only for master-video-change events: The id of the Video Cloud master account for the master video.
event 이벤트 유형 - 현재는 항상video-change
video 비디오 ID
version 비디오 버전-각 변경 이벤트 세트는 비디오 버전을 증가시킵니다. 예를 들어, 새로운 변환 세트를 생성하면 일련의 변경 이벤트가 구성됩니다.
action[1-1] 수행된 작업 - 다음 중 하나:
  • UPDATE - 자산이 업데이트되었습니다.
  • CREATE - 자산이 생성되었습니다.
  • TRIGGERED_MANUAL - 내부 브라이트코브 애플리케이션에서 알림이 트리거되었습니다.
  • DELETE - 자산이 삭제됨
    		•
    updated_by[1-1] 가능한 경우 조치를 수행한 사람에 대한 정보를 포함하는 객체 개체 속성은 다음과 같습니다.
  • email - 사용자의 이메일 주소
  • id - 사용자의 비디오 클라우드 시스템 ID
  • type - 업데이트 유형:
    • user - 스튜디오의 사용자
    • api-key - API를 통한 사용자
    • internal - 브라이트코브 시스템 또는 사용자
    		•

    구독 생성 요청은 다음 조건에 대한HTTP 422오류 응답을 받게 됩니다.

    • 요청 본문에endpoint or events필드가 누락되었습니다.
    • events필드 값이 목록 (배열) 이 아닙니다.
    • 정의 된 구독이 이미 있습니다.
    • 이 이벤트에 대한 구독이 이미 10 개 있습니다.

    알림 실패

    알림 시스템은 고객 서버의 모든 오류4xx또는5xx반품을 재시도 가능한 실패로 간주합니다. 실패한 콜백은 최대 20 회까지 다시 시도되며 후속 콜백 간의 지연이 기하 급수적으로 증가합니다. 처음 몇 번의 재시도는 초기 콜백 시도 후 몇 분 이내에 발생합니다. 콜백이 계속 실패하고 20 번째 재시도로 나아갈 경우 재시도 지연은 며칠이 걸릴 것입니다.

    방화벽

    조직에서 방화벽을 통해 수신되는 트래픽 소스에 대한 엄격한 정책이있는 경우 AWS us-east-1 / Virginia IP를 허용합니다. 이는 변경될 수 있으므로 모든 AWS IP를 허용 목록에 추가해야 합니다. 보다 https://docs.aws.amazon.com/general/latest/gr/aws-ip-ranges.html자세한 내용은.

    알림 구독을위한 끝점

            /accounts/{account_id}/subscriptions

    구독 목록 가져 오기

    모든 구독 목록을 보려면 구독 엔드포인트에GET요청을 보내십시오.

    /accounts/{account_id}/subscriptions

    단일 구독 가져 오기 또는 삭제

    다음 끝점을 사용하여 단일 구독을 가져 오거나 삭제합니다.

    끝점

    /accounts/{account_id}/subscriptions/{subscription_id}

    GET요청을 하면 구독이 검색됩니다. DELETE요청을 하면 구독이 삭제됩니다. 지금은 구독을 업데이트 할 수 없습니다. 구독을 수정하려면 구독을 삭제하고 새로 만들어야합니다.

    알림을 트리거하는 것은 무엇입니까?

    video-change이벤트는 비디오 메타데이터가 변경되면 트리거됩니다. 여기에는 Studio에서 또는CMS API쓰기 메서드를 통한 비디오 변경이 포함됩니다. 이벤트를video-change트리거하는 시스템 이벤트도 있습니다.

    이벤트를 트리거하는 변경 사항은 다음과 같습니다.

    • 비디오가 생성됩니다.
    • 비디오 또는 자산 파일 수집 시작
    • 비디오 또는 자산 파일 수집이 완료되었습니다.
    • 새 변환의 인코딩이 완료됩니다.
    • 포스터 이미지가 생성됩니다.
    • 썸네일 이미지가 생성됩니다.
    • 동영상이 활성화 또는 비활성화됨
    • 비디오가 삭제되었습니다
    • 비디오 메타 데이터가 변경됨 (시스템 또는 사용자에 의해)
    • master-video-change이벤트는 마스터 비디오의 자산 업데이트에 의해 트리거되므로 공유만 가능합니다.

      이 이벤트를 트리거하는 변경 사항은 다음과 같습니다.

      • 수집된 자산이 마스터 비디오에 추가됩니다.
      • 수집된 자산은 마스터 비디오에서 대체/재트랜스코딩됩니다.

    참고 사항

    결과 렌디션 세트가 달라지지 않는 한 비디오를 다시 트랜스코딩해도video-change이벤트가 트리거되지 않습니다.

    동영상이 삭제 된 후 발생하는 시스템 이벤트가 있으므로 삭제 후 알림을 받게됩니다.

    무엇을 ~ 아니다트리거 a video-change이벤트는 비디오 메타데이터를 변경하지 않는 비디오 자산에 대한 변경입니다. 예를 들어 원격 텍스트 트랙 파일 또는 이미지를 교체했지만 비디오 메타데이터에 기록된 URL이 그대로 유지되면video-change이벤트가 발생하지 않고 알림이 전송되지 않습니다.

    마스터 비디오에서 자산을 삭제해도master-video-change이벤트가 트리거되지 않습니다. 비디오에서 자산이 제거되면 비디오가 삭제되고 공유가 이미 제휴 비디오의 삭제 프로세스를 처리하기 때문입니다.