API 요청에 Postman 사용

설치하기Postman

Postman에서 가져와postman.com . 사용할 수 있는 온라인 버전이 있지만 데스크톱 앱을 설치하는 것이 좋습니다.

클라이언트 자격 증명 가져오기

브라이트코브 API를 사용하려면 사용하려는 계정과 API에 대한 클라이언트 자격 증명이 필요합니다. API 인증 자격 증명관리의 지침에 따라 Studio에서 클라이언트 자격 증명을 가져오세요 . 아래 단계에서는 를 사용하여 CMS API를Postman요청하므로 자격 증명에는 최소한 다음 권한이 있어야 합니다.

• Video: Read/Write

원하는 만큼 추가 권한을 추가하여 광범위한 API 요청에 사용할 수 있는 자격 증명을 얻을 수 있습니다. 또한 원하는 경우 여러 계정에 대해 작동하는 자격 증명을 얻을 수 있습니다.

당신이 사용할 수있는이 온라인 앱너가 선호한다면. 그럴 경우 최소한video-cloud/video/all권한을 지정해야 합니다.

OpenAPI 사양 가져오기

필수는 아니지만 사용하려는Postman API의 OpenAPI 사양을 가져오도록 설정을 크게 단순화할 수 있습니다. 모든 Brightcove 플랫폼 API에 대해 이 작업을 수행할 수 있지만 이 자습서에서는 CMS API를 사용합니다.

OpenAPI 사양을 얻으려면 CMS API 참조 로 이동하여 다운로드 버튼을 클릭하십시오.

다운로드한 파일이 호출됩니다. openapi.yaml

OpenAPI 사양 가져오기

다음 단계는 Postman 앱을 실행한 다음 다운로드한 OpenAPI 사양을 가져오는 것입니다.

컬렉션 열기

API를 가져오면 Postman에서 요청 모음을 생성합니다.

1. 컬렉션 을 클릭합니다.
2. 새 CMS API 컬렉션을 선택합니다.
3. 컬렉션을 확장하고 비디오 폴더를 클릭하고 비디오 가져오기 요청을 선택합니다.

   

   

Postman은 요청 자체 및 요청에 추가할 수 있는 매개 변수를 포함하여 API 참조에서 대부분의 세부 정보를 설정했습니다. 또한 매개변수에 대한 문서를 제공하고 값을 편집하고 요청과 함께 보내지 않으려는 항목의 선택을 취소할 수 있습니다.

그러나 계정 ID 및 인증 정보를 포함하여 일부 정보를 제공해야 합니다. 요청별로 이 작업을 수행할 수 있지만 더 좋은 방법은 일반적으로 사용되는 정보를 변수로 저장할 수 있는 요청에 대한 환경을 만드는 것입니다. 다음 섹션에서 그렇게 하겠습니다.

환경 만들기

아래 단계는 CMS API 요청을 위한 환경 설정을 안내합니다.

1. 클릭환경 훑어보기아이콘을 누른 다음추가하다 :

   

2. 환경 이름을 편집하여 "Brightcove API"로 변경합니다(필요에 따라 새 변수를 추가하여 다른 Brightcove API에도 이 환경을 사용할 수 있음).

   

3. "새 변수 추가" 텍스트를 클릭하고 다음을 입력합니다. account_id을 클릭한 다음초기 값입력란에 Video Cloud 계정 ID를 입력합니다(그런 다음 CURRENT VALUE에 대해서도 동일하게 수행).

   

4. 다른 변수를 추가하려면 이전 단계를 반복합니다.

   환경 변수

   변수	초기 값
   client_id	(귀하의 클라이언트 ID - 위의 클라이언트 자격 증명 가져오기 참조)
   client_secret	(클라이언트 암호 - 위의 클라이언트 자격 증명 가져오기 참조)
   access_token_url	https://oauth.brightcove.com/v4/access_token

5. 저장을 클릭하여 환경을 저장합니다.

   

6. Brightcove CMS API 컬렉션으로 돌아가 환경 선택기에서 생성한 환경을 선택합니다.

   

환경 변수는 이중 중괄호로 묶어서 참조할 수 있습니다(예: {{client_id}}). Postman은 "{{..."를 입력할 때 자동 완성을 도와줍니다. 비디오가져오기요청으로 돌아가서 경로 변수의값필드에 “{{a”를 입력하여 이 작업을 시도해 볼 수 있습니다account_id .

요청 활성화

이제 환경이 설정되었으므로 변수를 사용하여 요청을 테스트할 수 있습니다. Get Videos 요청을 먼저 살펴보겠습니다.

1. 아직 입력하지 않았다면account_id경로 변수 값으로 {{account_id}} 를 입력하십시오 .
2. 요청에 대한 승인 탭을 클릭합니다.

   

3. 구성옵션에서권한 부여 유형을클라이언트 자격 증명으로변경합니다.

   

4. 해당 필드에 환경의 다음 변수를 입력합니다.
   • 액세스 토큰 URL: {{access_token_url}}
   • 클라이언트 ID: {{client_id}}
   • 클라이언트 시크릿: {{client_secret}}
5. 새 액세스 토큰가져오기를 클릭합니다 .

   

6. 인증이 완료되면 진행을 클릭하거나 토큰이 나타날 때까지 기다릴 수 있습니다. 그런 다음 클릭토큰 사용 :

   

브라이트코브 액세스 토큰은 5분 후에 만료된다는 점에 유의하세요. 수행 중인 작업과 속도에 따라 동일한 액세스 토큰을 여러 번 사용할 수 있습니다. 만료되면 CMS API는 승인되지 않은 오류를 반환합니다.

[
	{
			"error_code": "UNAUTHORIZED",
			"message": "Permission denied."
	}
]

(정확한 메시지 형식은 다른 API에 따라 다를 수 있지만 비슷할 것입니다.)

이 경우 Authorization 탭으로 돌아가서 새 토큰을 요청하면 됩니다. 더 이상 가치가 없으므로 혼동을 피하기 위해 만료된 토큰도 삭제해야 합니다.

요청하다

이제 Get Videos 요청을 할 준비가 되었습니다.

1. 매개변수 탭으로 돌아가 모든 쿼리 매개변수를 선택 취소합니다(물론 매개변수를 사용하고 값을 변경할 수 있지만 이 첫 번째 테스트에는 기본값만 사용합니다).
2. [ 보내기] 를 클릭합니다 .
3. 아래 응답 영역(동영상 메타데이터 개체 배열)에 JSON 코드가 표시되어야 합니다.

   

4. 이제 쓰기 요청(동영상 만들기)을 시도합니다. 컬렉션에서 해당 요청을 선택합니다.

   

5. 다시 입력해야 합니다. ~을 위해계정 ID 경로 변수 . 당신은아니다 Postman은 이러한 설정을 컬렉션의 다른 요청으로 전송하기 때문에 이전 섹션의 단계를 반복하여 승인을 설정해야 합니다. 하지만여전히 새 액세스 토큰을 생성해야합니다.
6. 그런 다음 본문 탭으로 이동하면 API 참조의 샘플 요청 본문이 표시됩니다.

   

7. 이 JSON은 편집 가능합니다. Create Video 요청에 필요한 유일한 필드는 이므로 해당 값을 “Test Video”로 변경하고 나머지 JSON을 제거하여 요청 본문이 다음과 같도록 하십시오. name

   {
   	"name": "Test video"
   }

8. 이제 보내기(필요한 경우 새 액세스 토큰 가져오기)를 클릭하면 새 비디오에 대한 메타데이터 개체가 응답 영역에 나타나는 것을 볼 수 있습니다.

関連トピック

• 브라이트코브 API용 테스트 도구
• API 요청에 대한 인증
• 온라인 API 테스터
• API 요청에 불면증 사용