지원 고객 지원 문의 | 시스템 상태 시스템 상태
페이지 내용

    개요: 정책 API

    이 항목에서는 정책 API의 용도와 사용 방법에 대해 알아봅니다. 정책 API는 정책 키를 만들거나 가져오는 데 사용됩니다.
     

    서문

    그만큼정책 키비디오 클라우드 라이브러리에서 비디오 및 재생 목록 콘텐츠를 검색하는 데 사용됩니다. 재생 API .

    또한 참조 API 참조 .

    하나 필요하세요?

    고유 한 정책 키를 생성해야하는 특수한 경우 만 있습니다.

    • Brightcove 플레이어를 만들 때 정책 키가 자동으로 생성됩니다. 플레이어에 대해 지역 필터링이 포함 된 키를 가져 오거나 플레이어를 생성하지 않고 Playback API에 액세스하려는 경우에만이 API를 사용하여 직접 정책 키를 생성하면됩니다. 일반적으로 이는장치 SDK . 보다정책 키 Brightcove Player에 대한 정책 키를 얻는 방법에 대한 지침.
    • 비디오 검색 요청 수행 :
      • 당신은검색 가능 정책 키 .
      • 새 Brightcove 플레이어에 대해 생성 된 정책 키는 기본적으로 검색이 활성화되지 않습니다. 다음을 사용하여 수동으로 설정해야합니다. 정책 API .
      • 일반적으로 검색이 활성화된 정책 키는 재생 가능한 모든 동영상을 나열하는 데 사용할 수 있으므로 브라우저 플레이어나 모바일 앱이 아닌 서버에만 저장해야 합니다. 일부 계정의 경우 재생 가능한 모든 비디오를 검색 할 수 있다는 점에 신경 쓰지 않으면 적용되지 않을 수 있습니다.
      • 검색 요청은 재생 가능한 동영상 만 반환합니다. API 요청 / 응답에 대한 자세한 내용은비디오 받기섹션재생 API 참조 .

    자주하는 질문

    다음은 일반적으로받는 정책 API에 대한 몇 가지 질문입니다.

    여러 계정에 대해 정책 키를 만들 수 있습니까? 아니면 하나만 만들 수 있습니까?
    정책 키를 사용하면 하나의 계정으로 동영상과 재생 목록에 액세스 할 수 있습니다. 여러 계정이있는 경우 각 계정에 대한 정책 키를 만들어야합니다.
    정책 키가 만료됩니까?
    아니요, 정책 키는 영원히 좋습니다. 정책 키를 취소해야하는 경우 Brightcove 지원 -요청에서 취소하려는 계정 ID와 정책 키를 포함합니다.
    계정의 모든 사용자에 대해 정책 키가 작동합니까?
    예, 정책 키가있는 사람은 누구나 사용할 수 있습니다.
    정책 키를 업데이트 할 수 있습니까?
    아니요, 정책 키를 업데이트 할 방법이 없습니다. 당신은정책 키 얻기 Video Cloud 계정의 기존 플레이어에서 가져 오거나 Policy API를 사용하여 새 정책 키를 만들 수 있습니다.

    기본 URL

    정책 API의 기본 URL은 다음과 같습니다.

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

    계정 경로

    모든 경우에 특정 Video Cloud 계정에 대한 요청이 이루어집니다. 따라서 항상/accounts/ 기본 URL에 대한 계정 ID가 뒤 따릅니다.

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

    인증

    요청은에 전달 된 액세스 토큰에 의해 인증됩니다. Authorization 머리글:

        Authorization: Bearer {access_token}

    액세스 토큰을 얻으려면 다음 단계를 따르십시오.

    1. 클라이언트 자격 증명 ( client_id client_secret ) 통해비디오 클라우드 스튜디오 (권장).

      정책 키 생성 요청과 함께 사용할 수있는 액세스 토큰의 경우 클라이언트 자격 증명이 Studio에서 다음 권한을 가지고 있어야합니다. 플레이어 읽기 및 읽기 / 쓰기

      인증 권한
      인증 권한

      클라이언트 자격 증명을 직접 얻을 수도 있습니다. Brightcove OAuth API .

    2. 클라이언트 자격 증명이 있으면 다음을 수행 할 수 있습니다. OAuth API에서 임시 액세스 토큰 얻기 .

    필수 헤더

    여기에 덧붙여Authorization이전 섹션에서 논의한 헤더, 요청에는Content-Type머리글:

        Content-Type: application/json

    정책 키 만들기

    새 정책 키를 생성하려면 POST 요청을 수행하십시오.

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

    요청 본문

    요청 본문에 정책에 대한 JSON을 포함합니다.

        {
          "key-data": {
            "account-id": "{account_id}"
          }
        }

    이것은 계정에 대한 액세스를 제한하는 가장 기본적인 정책이며 생성하는 모든 정책에이를 포함해야합니다. 여기의 계정 ID는 요청 URL의 계정 ID와 일치해야합니다. 그렇지 않으면 오류가 반환됩니다.

    도메인 제한

    계정에 대한 액세스를 제한하는 것 외에도 다음을 추가하여 특정 도메인에 대한 액세스를 제한 할 수 있습니다. allowed-domains 키:

        {
          "key-data": {
            "account-id": "123456789001",
            "allowed-domains": [
              "http://www.abc.com",
              "https://www.abc.com",
              "http://www.xyz.com",
              "https://www.xyz.com"
            ]
          }
        }

    지리적 제한

    정책 API를 사용하여 플레이어에 대한 지역 필터링을 구현할 수 있습니다. 개별 동영상.

    샘플

    다음은 미국 및 미국 영토와 군사 기지에서만 재생을 허용하는 허용 목록 정책 세트의 예입니다.

        {"account-id": "8523232323",
          "geo": {
            "countries": ["us", "usmil", "pr", "gu", "vi", "as", "mp"],
            "exclude_countries": false
          }
        }

    대신 해당 국가를 블랙리스트에 추가하려면exclude_countries 사실로.

    SSAI가 필요합니다

    SSAI (Server-Side Ad Insertion)로 작업 할 때 API 요청에 적절한 광고 구성을 적용하는 방법이 필요할 수 있습니다. 이렇게하려면 정책 키를 구성하여ad_config_id 모든 Playback API 요청에 URL 매개 변수로 추가됩니다.

    샘플

    다음은 예입니다.

        {
          "key-data": {
            "account-id": "1752604059001",
            "require-ad-config": true
          }
        }

    사용에 대한 자세한 내용은ad_config_id Playback API 요청에 대해서는재생 API 개요 : SSAI로 비디오 요청문서.

    동영상 검색

    비디오 검색 요청을 수행 할 때 검색이 활성화 된 정책 키를 사용해야합니다. 검색 가능한 정책 키를 만들려면 호출의 요청 본문에 다음이 포함되어야합니다.

        {
          "key-data": {
            "account-id": "57838016001",
            "apis": ["search"]
          }
        }

    API 응답

    정책 생성 요청에 대한 응답은 암호화 된key-string Playback API에 대한 요청 및 키와 관련된 정책을 인증하는 데 사용할 수 있습니다.

        {
          "key-data": {
            "account-id": "57838016001"
          },
          "key-string": "BCpkADawqM0NK0Rq8n6sEQyWykemrqeSmIQqqVt3XBrdpl8TYlvqN3hwKphBJRnkPgx6WAbozCW_VgTOBCNf1AQRh8KnmXSXfveQalRc5-pyNlSod5XzP99If2U"
        }

    정책 요청

    다음과 관련된 정책 개체를 검색하려면key-string , 다음에 대한 GET 요청을 작성하십시오.

        /accounts/v1/{account_id}/policy_keys/{key_string}

    응답은 키 문자열 및 정책의 JSON 표현입니다.

        {
          "key-data": {
            "account-id": "57838016001"
          },
          "key-string": "BCpkADawqM0NK0Rq8n6sEQyWykemrqeSmIQqqVt3XBrdpl8TYlvqN3hwKphBJRnkPgx6WAbozCW_VgTOBCNf1AQRh8KnmXSXfveQalRc5-pyNlSod5XzP99If2U"
        }

    정책 취소

    기존 정책을 취소해야하는 경우 다음 주소로 요청을 제출하십시오. Brightcove 지원 . 요청에서 취소하려는 정책의 키 문자열을 포함합니다.