서문
일부는 플랫폼 API 문서의 많은 예제에 사용되는 curl 문과 명령 줄을 찾기 어렵고 위협적입니다. 이를 위해 대부분의 브라이트코브 API를 포함하는 REST 기반 서비스에 HTTP 요청을 보낼 수 있는 다양한 도구가 있습니다. 이 문서는 널리 사용되는 도구 인Insomnia앱 .
설치Insomnia
가져 오기Insomnia ...에서https://insomnia.rest . Insomnia Mac, Linux 또는 Windows 시스템에 설치할 수 있습니다.
Insomnia Brightcove의 RESTful API를 요청하는 데 사용할 수 있습니다. 대부분의 API는 인증에 OAuth2를 사용하며 이것이이 문서에서 설명하는 것입니다. 그러나 적절한 헤더를 설정하기 만하면 OAuth를 사용하지 않는 API에도 사용할 수 있습니다.

다음은 인증 방법이 다른 요청에 대한 헤더의 모습입니다.
- OAuth API (자격 증명 요청 생성뿐 )
-
Authorization: BC_TOKEN YOUR_BC_TOKEN
- Playback API
-
BCOV-Policy: YOUR_POLICY_KEY
- Live API
-
X-API-KEY: YOUR_API_KEY
- Zencoder API
-
Zencoder-Api-Key: YOUR_API_KEY
클라이언트 자격 증명 가져오기
대부분의 Brightcove API를 사용하려면 사용하려는 계정 및 API에 대한 클라이언트 자격 증명이 필요합니다. API 인증 자격 증명 관리의 지침에 따라 Studio에서 클라이언트 자격 증명을가져옵니다. 아래 단계에서 우리는Player Management API사용 요청Insomnia이므로 자격 증명에는 최소한 다음 권한이 있어야합니다.
- 플레이어 : 읽기 / 쓰기
원하는 만큼 추가 권한을 추가하여 광범위한 API 요청에 사용할 수 있는 자격 증명을 얻을 수 있습니다. 또한 원하는 경우 여러 계정에서 작동하는 자격 증명을 얻을 수 있습니다.
사용Insomnia
클라이언트 자격 증명이 있으면 사용할 준비가 된 것입니다. Insomnia . 아래 단계는 몇 가지를 만드는 과정을 안내합니다. 플레이어 관리 API사용 요청Insomnia .
설정Insomnia작업 공간
다른 API로 작업하는 경우 Brightcove 요청만을위한 작업 영역을 생성 할 수 있습니다.
- 시작Insomnia앱.
- 옆에있는 드롭 다운을 클릭합니다. Insomnia그리고 선택새 작업 공간 :
Insomnia승인 섹션 - 이름을 입력하세요 Brightcove클릭창조하다 :
승인 유형 - 클릭더하기 기호그리고 선택새 폴더 :
새 폴더 만들기 - 폴더 이름을 지정하십시오. Player Management API
GET
요청 보내기
이제 API 요청을 할 준비가되었습니다.
GET
요청 만들기
- 새 폴더에서 드롭 다운 메뉴 아이콘을 클릭하고새로운 요청 :
새 요청 - 요청에 이름을 지정하십시오. 모든 플레이어 얻기 , HTTP 메서드를 다음과 같이 둡니다.
GET
을 클릭하고 만들기를 클릭합니다. - 일반 요청 URL을 다음으로 바꿉니다.
https://players.api.brightcove.com/v2/accounts/account_id/players
바꾸다계정 ID자신의 계정 ID로 :
새 요청 - 확장인증드롭 다운 메뉴를 선택하고 OAuth 2.0 :
인증 메뉴 - 에 대한부여 유형 , 고르다클라이언트 자격 증명 :
보조금 유형 - 액세스 토큰 URL, 클라이언트 ID 및 클라이언트 비밀번호에 대한 값을 입력하십시오.
OAuth 항목 액세스 토큰 URL https://oauth.brightcove.com/v4/access_token 클라이언트 ID 귀하의 고객 ID 클라이언트 시크릿 당신의 고객 비밀 - 딸깍 하는 소리토큰 가져 오기이것이 작동하는지 확인하십시오. 다음과 같은 응답이 표시되어야합니다.
액세스 토큰 - 딸깍 하는 소리보내다 :
GET
요청 - 응답은 다음과 같아야합니다.
GET
응답
POST
요청 보내기
이제 우리는POST
일부 데이터로 요청하십시오. 이 경우 플레이어 관리 API를 사용하여 새 비디오 개체를 만듭니다.
이를 위해 우리는모든 플레이어 얻기필요에 따라 요청하고 수정합니다. 의 또 다른 좋은 기능Insomnia요청을 복제하면 모든 인증 정보가 함께 복제되므로 액세스 토큰을 다시 가져 오도록 설정할 필요가 없습니다.
POST
요청 만들기
- 클릭플레이어 관리 API표시 할 폴더모든 플레이어 얻기내부 요청.
- 드롭 다운 메뉴를 확장합니다. 모든 플레이어 얻기요청 및 선택복제 :
중복 요청 - 이름을 두 번 클릭하십시오. 모든 플레이어 가져 오기 (복사)그리고 그것을플레이어 만들기
- 위의 GET 요청 단계에서 사용한 것과 동일한 URL을 사용하지만 이제
POST
선택된 HTTP 메소드가됩니다.변경 방법 - 클릭몸드롭 다운 메뉴를 확장하고 JSON :
본체 유형 선택 - 에 대한몸데이터에서 본문에 대해 다음 JSON 코드를 입력합니다 (JSON 다음 스크린 샷은 요청이 어떻게 표시되어야하는지 보여줍니다).
{ "name": "MySamplePlayer", "configuration": { "media": { "sources": [{ "src":"http://solutions.brightcove.com/bcls/assets/videos/Tiger.mp4", "type":"video/mp4" }] } } }
{ "name": "MySamplePlayer", "configuration": {} }
요청 본문 요청 본문 - 보내기를클릭합니다.
-
응답은 다음과 유사합니다 (좀 더 멋지게 형식화 된 JSON을 보려면 [ 프리티 ] 버튼을 클릭 할 수 있습니다).
POST
응답 - Studio의 플레이어 모듈을 확인하여 플레이어가 생성되었는지 확인할 수 있습니다.
환경 변수
사용하는 것이 도움이 될 수 있습니다. Insomnia '에스환경다른 API에 대한 OAuth 자격 증명을 저장하거나 계정 ID 및 비디오 또는 플레이어 ID와 같은 기타 정보를 저장합니다.
다음은 환경 변수를 만들고 사용하는 단계입니다. client_id
, client_secret
과account_id
.
- 딸깍 하는 소리환경 없음의 왼쪽 상단 영역Insomnia드롭 다운 메뉴를 확장하고환경 관리.
환경 메뉴 - 에서환경 관리대화 상자에서 +옆에 서명하위 환경드롭 다운 메뉴를 확장하고환경새 환경을 만들려면 :
환경 추가 - 더블 클릭새로운 환경변경할 이름플레이어 관리 API (또는 원하는대로).
- 환경 JSON의 중괄호 안에 다음 키-값 쌍을 추가합니다.
"account_id"
: " 귀하의 계정 ID ""client_id"
: " 귀하의 고객 ID ""client_secret"
: " 당신의 고객 비밀 "
완료되면 JSON이 다음과 같이 표시됩니다.
환경 JSON 추가 (여기서 클라이언트 비밀은 보안상의 이유로 흐리게 표시됩니다.)
- 딸깍 하는 소리끝난환경을 추가하려면
- 딸깍 하는 소리환경 없음다시 드롭 다운을 확장하고플레이어 관리 환경 사용 (또는 새 환경에 지정한 이름) :
환경 선택 - 이제모든 플레이어 얻기다시 열도록 다시 요청하십시오.
- 딸깍 하는 소리 OAuth 2인증 섹션을 다시 엽니 다.
- 클라이언트 ID 값을 삭제하고 입력을 시작합니다. client_id -선택해야하는 관련 환경 변수를 보여주는 드롭 다운 메뉴가 나타납니다. client_id :
환경 변수 드롭다운 - 이제계정 ID요청 URL에서계정 ID변하기 쉬운.
- 교체하기 위해 동일한 작업을 수행하십시오. 클라이언트 비밀가치 client_secret변하기 쉬운.
- 이제 클릭보내다다시 요청이 작동하는지 확인합니다.
결론
이제 사용의 기본 사항을 알았습니다. Insomnia Brightcove API에 요청합니다. 무료 업그레이드를 선택한 경우Insomnia계정에 팀 계정을 추가하면 모든 요청과 환경을 동기화하고 다른 팀 구성원과 공유 할 수도 있습니다.