지원 지원 문의 | 시스템 상태 시스템 상태

개요 : CMS API

이 항목에서는 CMS API. 그만큼 CMS API 캐시되지 않은 읽기 액세스를 데이터에 제공합니다. 이는 시간에 민감한 게시 워크 플로에서 중요합니다. CMS API 정확한지 확인하기 위해 데이터를 빨리 읽으십시오.

API 참조

또한 API 참조.

일반 정보

기본 URL

의 기본 URL CMS API 입니다

        https://cms.api.brightcove.com/v1

계정 경로

모든 경우에있어 요청은 특정 Video Cloud 계정. 그래서, 당신은 항상 용어를 추가 할 것입니다. accounts 계정 ID가 기본 URL에 이어집니다.

        https://cms.api.brightcove.com/v1/accounts/{account_id}

인증

요청에 대한 인증에는 Authorization header :

        Authorization: Bearer {access_token}

그리고, access_token 은 (는) 임시 OAuth2 액세스 토큰입니다. Brightcove OAuth 서비스. 자세한 내용은 Brightcove OAuth 개요.

클라이언트 자격 증명을 만드는 가장 쉬운 방법은 Brightcove Studio 관리 페이지를 이용하는 것입니다. 자세한 지침은 다음을 참조하십시오. API 인증 자격 증명 관리

운영

클라이언트 자격 증명을 요청할 때 원하는 계정 액세스 유형을 지정해야합니다. 다음은 현재 지원되는 작업의 목록입니다. CMS API :

  • 비디오 데이터 :

    video-cloud/video/read
    video-cloud/video/create
    video-cloud/video/update
    video-cloud/video/delete
    or
    video-cloud/video/all
    video-cloud/video/assets/delete (디지털 마스터를 삭제하려는 경우에만 필요합니다. ~ 할 수 없다. Studio에서 자격 증명을 만들 때이 권한을 얻습니다. 그것은을 통해 수행되어야합니다 OAuth API 또는 Brightcove Learning Services에서 만든 샘플 앱.)

  • 재생 목록 데이터 :

    video-cloud/playlist/read
    video-cloud/playlist/create
    video-cloud/playlist/update
    video-cloud/playlist/delete
    or
    video-cloud/playlist/all

  • 알림 :
    • video-cloud/notifications/all (에 대한 알림)

속도 제한

CMS API 캐시되지 않은 읽기 액세스를 데이터에 제공합니다. 이는 시간에 민감한 게시 워크 플로에서 중요합니다. CMS API 정확한지 확인하기 위해 데이터를 빨리 읽으십시오.

그리고, CMS API (트래픽이 많은 공개 웹 페이지의 비디오에 액세스하는 것과 같이) 대규모 런타임 사용에는 적합하지 않습니다. 트래픽이 많은 응용 프로그램의 경우 다음과 같은 캐시 된 인터페이스를 사용해야합니다. Playback API , Gallery, Player또는 기본 SDK입니다.

성능을 보장하려면 Video Cloud 시스템에서 20 동시 호출 만 CMS API 계정 당 허용됩니다. 액세스 빈도는 초당 10 요청보다 적어야합니다.

여러 응용 프로그램이 CMS API 계정의 경우 이러한 응용 프로그램은 동시성 한계 또는 속도 한계에 도달하는 인스턴스를 처리하기 위해 백 오프 및 재시도 논리를 가져야합니다.

속도 또는 동시 실행 한계를 초과하면 429 - TOO_MANY_REQUESTS 오류가 반환됩니다.

참조 ID 충돌

참조 ID의 고유성을 보장하기 위해 CMS API 할당 된 비디오에 대한 작업이 완료된 후 최대 3 분 동안 ID를 잠급니다. 이렇게하면 너무 빨리 실패한 요청을 다시 시도하거나 이전에 할당 된 비디오를 삭제 한 후 너무 빨리 참조 ID를 다시 사용하려고하면 409 오류가 반환 될 수 있습니다. 자세한 내용은 오류 메시지 참조 자세한 내용은.

동영상 저작물 한도

동영상 당 1,000 개 애셋의 한도가 있습니다. 자산에는 렌더, 오디오 트랙, 텍스트 트랙 및 이미지는 물론 디지털 마스터가 포함됩니다. 렌 디션과 이미지는 10-15 애셋 이상으로 거의 합계되지 않으므로 150 언어에 대한 오디오 트랙과 텍스트 트랙을 분리해도 350 애셋보다 적은 애셋을 사용할 수 있습니다.

사용상의주의 사항

행동 양식

현재 API는 다음 요청 유형을 지원합니다.

  • GET
  • POST
  • PATCH
  • PUT
  • DELETE

매개 변수

모든 매개 변수는 선택. 명시된 경우를 제외하고는 다음에 적용됩니다. GET 동영상 및 재생 목록 요청

GET 요청 매개 변수
매개 변수 설명
q 검색을위한 쿼리 문자열 - 참조 검색 구문 자세한 내용은
limit 반환 할 동영상 수 - 1와 100 사이의 정수 여야합니다. 기본값 : 20
offset 건너 뛸 비디오 수 (페이징 결과). 양의 정수 여야합니다. 기본값 : 0
sort 정렬 할 필드를 지정하는 문자열. 시작하다 - 내림차순 정렬. 에 대한 값이 q 가 제공되면 기본 정렬은 "점수"(검색 결과와 원래 쿼리의 관련성)입니다. 값이없는 경우 q 이 제공되면 기본 정렬은 updated_at 내림차순. 다음 필드는 정렬에 유효합니다. name, reference_id, created_at, published_at, updated_at, schedule_starts_at, schedule_ends_at, state, plays_totalplays_trailing_week

브라이트 코브 CMS API 귀하의 동영상을 검색 할 수있는 프로그램 방식을 제공합니다. Video Cloud 도서관.

비디오 데이터에 대한 기본 및 복잡한 검색을 수행하려면 q 매개 변수 :

        https://cms.api.brightcove.com/v1/accounts/921483702001/videos?q={search terms}

동영상을 검색하는 방법에 대한 자세한 내용은 동영상 검색 문서를 참조하시기 바랍니다.

재생 목록의 경우 검색 문자열에 지원되는 값이 더 제한됩니다. 현재 검색 할 수 있습니다. type, name, descriptionreference_id. 다음은 유효한 검색의 예입니다.

  • q=type:EXPLICIT
  • q=type:ACTIVATED_OLDEST_TO_NEWEST
  • q=type:ALPHABETICAL
  • q=bears+otters (이름, 설명 또는 참조 ID에는 "곰"또는 "수달"중 하나가 포함되어야 함)
  • q=%2Bname:bears+type:EXPLICIT (이름은 "곰"을 포함해야 함)

만나다 재생 목록 검색 자세한 내용은.

페이징 결과

사용 limit 매개 변수를 사용하여 요청에서 반환 할 항목 수를 지정합니다 (최대 100까지). 그런 다음 offset 매개 변수보다 큰 결과 집합을 페이징하는 매개 변수 limit. 그만큼 offset 건너 뛸 항목 수입니다.

예를 들어 다음 검색은 총 결과 집합에 적어도 51 개의 동영상이 있다고 가정하고 총 결과 집합의 동영상 75-75을 반환합니다.

        /videos?q=updated_at:2014-01-01..2014-06-30&limit=25&offset=50

그리고, limitoffset 매개 변수는 동영상과 재생 목록 모두에 사용할 수 있습니다.

페이징 모범 사례

동시 수정 작업이 CMS API결과 집합을 페이징 할 때 다음 단계를 따르는 것이 좋습니다.

  1. 을 만들다 count 결과 집합에 총 동영상 수를 요청합니다.
          /accounts/578380111111/counts/videos?q=tags:nature
  2. 사용 limit offset 매개 변수를 사용하여 결과 집합에서 데이터 그룹을 반환합니다.
          /accounts/578380111111/videos?q=tags:nature&limit=20&offset=50
  3. 일부 페이지는 20 개 미만의 동영상을 포함 할 수 있습니다. 첫 번째 동영상과 같은 수의 동영상을 요청했을 때 결과 집합의 마지막에 도달했음을 알 수 있습니다. count 의뢰.

요약하면 비디오 카운트가 원본과 동일해질 때까지 페이지를 계속 검색하십시오. count 이 숫자는 과대 평가의 측면에서 잘못 되었기 때문에 요청. 요청 사항 :

      count / page-size + 1 page

동영상 검색 결과 정렬

매개 변수 사용 sort=field_name 결과를 정렬하는 방법을 지정하려면 비디오와 재생 목록을 모두 정렬 할 수 있습니다. 다음 비디오 필드를 정렬 할 수 있습니다. [1-1]

  • name
  • reference_id
  • created_at
  • published_at
  • updated_at
  • schedule_starts_at (참고 : 이것은 종류 분야 - 검색 필드 schedule.starts_at )
  • schedule_ends_at (참고 : 이것은 종류 분야 - 검색 필드 schedule.ends_at )
  • state
  • plays_total [1-2]
  • plays_trailing_week [1-2]

노트

  • [1-1] 비디오 검색 호출에 정렬 값을 제공하지 않으면 결과는 관련성에 따라 정렬됩니다. 에 대한 정렬 값을 제공하지 않으면 GET 동영상이 전화를 걸면 검색 결과는 updated_at 내림차순.
  • [1-2] 정렬 할 수 있습니다. plays_total or plays_trailing_week,이 필드는 결과에 포함되지 않습니다.

재생 목록 결과 정렬하기

다음 필드에서 재생 목록을 정렬 할 수 있습니다.

  • name
  • updated_at (기본값)

모든 동영상 및 대용량 데이터 세트

계정의 모든 동영상 또는 다수의 동영상을 검색하는 경우 알아 두어야 할 몇 가지 사항이 있습니다.

  1. 허용되는 최대 허용량을 사용하려고 할 수 있습니다. limit (100)하지만 25 이하의 동영상을 검색하여 API 요청 시간이 초과 될 가능성을 최소화하는 것이 좋습니다
  2. 대용량 데이터 세트를 통해 페이징 할 때 작동 중에 비디오 데이터가 업데이트되어 항목이 응답에서 벗어날 수 있습니다.
    • 연속되는 페이지에서 반복되는 항목을 볼 수 있습니다.
    • 이전 응답 세트로 이동했기 때문에 항목을 놓칠 수 있습니다.

    첫 번째 가능성을 설명하기 위해 동영상 검색을 마친 후에 앱에서 전체 항목 목록을 중복 제거해야합니다. 두 번째 가능성을 처리하려면 검색 한 총 항목 수 (중복 제거 후)를 예상 한 수와 비교 한 다음 요청을 다시 실행하고 last_modified_date (내림차순)로 결과를 정렬해야합니다. 누락 된 항목을 선택하기 위해 둘 이상의 배치를 검색하십시오.

  3. 반환 된 결과를 적절하게 정렬하여 이전 항목에서 시나리오의 가능성을 줄일 수 있습니다. 기본 정렬 기준 관련성 검색은 키워드, 태그 및 사용자 정의 필드 값의 조합을 찾는 복잡한 알고리즘을 기반으로합니다. 여러 키워드, 태그 및 / 또는 사용자 정의 필드를 기반으로 동영상을 검색하는 경우 관련성에 따른 정렬은 원하는 것입니다. 그러나 방금 또는 모든 동영상 세트를 검색하려는 경우 sort 매개 변수를 명시 적으로 사용하면 반환 된 항목의 순서를보다 세부적으로 제어 할 수 있습니다.

비디오 작업

비디오 작업에는 다음이 포함됩니다.

  • 동영상 또는 검색 결과 수 얻기
  • 모든 비디오 가져 오기
  • ID 또는 참조 ID로 하나 이상의 동영상 가져 오기
  • 비디오 생성, 검색, 업데이트 및 삭제
  • 동영상 검색
  • 비디오 소스, 이미지 및 디지털 마스터 정보 얻기
  • 동영상이 속한 재생 목록 가져 오기
  • 모든 재생 목록에서 비디오를 제거하십시오.

비디오 작업에 대한 자세한 내용은 API 참조.

재생 목록 작업

재생 목록 작업에는 다음이 포함됩니다.

  • 재생 목록 수 얻기
  • 모든 재생 목록 가져 오기
  • 재생 목록 생성, 업데이트 및 삭제
  • 재생 목록의 동영상 수 얻기
  • 재생 목록에서 동영상 가져 오기

재생 목록 작업에 대한 자세한 내용은 API 참조.

자산

자산 작업을 통해 렌더, 매니페스트, 이미지 및 텍스트 트랙을 포함한 자산을 관리 할 수 ​​있습니다. 저작물을 수집하려면 Dynamic Ingest API. 그만큼 POSTPATCH 에 대한 작업 CMS API /assets 추가 및 업데이트하는 데 사용할 수 있습니다. 원격 자산. CMS API GET 작업은 섭취 및 원격 자산.

  • 렌 디션 추가, 업데이트 또는 삭제
  • 디지털 마스터의 메타 데이터 추가, 업데이트 또는 삭제
  • HLS와 같은 세그먼트 화 된 비디오 유형에 대한 매니페스트를 추가, 업데이트 또는 삭제합니다.
  • 포스터 및 축소판 이미지 추가, 업데이트 또는 제거
  • WebVTT 텍스트 트랙 또는 DFXP 캡션 추가, 업데이트 또는 제거

자산 운용에 관한 세부 사항은 API 참조.

사용자 정의 필드 작업

현재 하나의 사용자 정의 필드 작업이 있습니다.

  • 계정에 대한 모든 맞춤 입력란 가져 오기

사용자 정의 필드 작업에 대한 자세한 내용은 API 참조.

폴더 작업

폴더 작업을 통해 다음을 수행 할 수 있습니다.

  • 폴더 목록 가져 오기
  • 폴더 만들기, 업데이트 및 삭제
  • 폴더에있는 동영상 목록 가져 오기
  • 폴더에 비디오 추가
  • 폴더에서 비디오 제거

폴더 작업에 대한 자세한 내용은 API 참조.

알림

다음과 같은 경우 알림을받을 수 있습니다. video_change 비디오 라이브러리에서 이벤트가 발생합니다. 알림은 지정한 URL로 전송되며, 처리 할 수있는 애플리케이션을 가리켜 야합니다. HTTP POST 요청.

알림 실패

통지 시스템은 고객 서버의 4xx 또는 5xx 리턴을 재 시도 가능한 실패로 처리합니다. 실패한 콜백은 20 번까지 재 시도되며 후속 콜백 간에는 기하 급수적으로 지연이 발생합니다. 처음 몇 번의 재시도는 초기 콜백 시도 후 몇 분 이내에 발생합니다. 콜백이 계속 실패하고 20th 재시도에 도달하면 재시도 지연이 며칠이 걸릴 것입니다.

방화벽

조직에서 방화벽을 통해 들어오는 트래픽 소스와 관련된 엄격한 정책이있는 경우 모든 AWS East 지역 IP를 허용합니다. 이는 변경 될 수 있으므로 모든 AWS IP는 허용 목록에 포함되어야합니다. 만나다 https://docs.aws.amazon.com/general/latest/gr/aws-ip-ranges.html 문의주시기 바랍니다.

알림 작업

현재 알림에 사용할 수있는 작업은 다음과 같습니다.

  • 구독 만들기
  • 하나 또는 모든 구독 정보 얻기
  • 구독 삭제

알림 작업에 대한 자세한 내용은 API 참조.


12 년 2020 월 XNUMX 일에 마지막으로 업데이트 된 페이지