개요: 정책 API

서문

정책 키는Playback API를 사용하여 Video Cloud 라이브러리에서 비디오 및 재생목록 콘텐츠를 검색하는 데 사용됩니다 .

API 레퍼런스도 참조하십시오 .

하나 필요하세요?

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

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

자주하는 질문

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

기본 URL

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

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

계정 경로

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

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

인증

요청은Authorization 헤더에 전달된 액세스 토큰으로 인증됩니다.

Authorization: Bearer {access_token}

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

1. 클라이언트 자격 증명을 얻습니다( client_id 그리고client_secret ) 을 통해비디오 클라우드 스튜디오 (권장).

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

   

   브라이트코브 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": [
          "https://www.abc.com",
          "https://www.abc.com",
          "https://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 올리려면 true로 설정하십시오.

SSAI가 필요합니다

SSAI (Server-Side Ad Insertion)로 작업 할 때 API 요청에 적절한 광고 구성을 적용하는 방법이 필요할 수 있습니다. 이를 위해서는 a가 모든 Playback API 요청에 URL 파라미터로 추가되도록 정책 키를 구성하면 됩니다. ad_config_id

샘플

다음은 예입니다.

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

재생 API ad_config_id 요청과 함께 를 사용하는 방법에 대한 자세한 내용은재생 API 개요를 참조하십시오. SSAI문서를 통한 비디오 요청.

동영상 검색

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

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

API 응답

정책 생성 요청에 대한 응답은 JSON이며, 여기에는 Playback API에 대한 요청을 인증하는 데 사용할 수 있는 암호화된key-string 데이터와 키와 관련된 정책이 포함됩니다.

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

정책 요청

key-string a와 관련된 정책 객체를 검색하려면 다음과 같이 GET 요청을 보내십시오.

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

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

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

정책 취소

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