API 요청에 Postman 사용

설치우편 집배원

얻다우편 집배원 ~에서우편 배달부.com . 사용할 수 있는 온라인 버전이 있지만 데스크톱 앱을 설치하는 것이 좋습니다.

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

Brightcove API로 작업하려면 사용하려는 계정 및 API에 대한 클라이언트 자격 증명이 필요합니다. 의 지침에 따라 Studio에서 클라이언트 자격 증명을 가져옵니다. API 인증 자격 증명 관리 . 아래 단계에서는 다음을 사용하여 CMS API 요청을 수행합니다. 우편 집배원 , 따라서 자격 증명에는 최소한 다음 권한이 있어야 합니다.

• Video: Read/Write

더 넓은 범위의 API 요청에 사용할 수 있는 자격 증명을 얻기 위해 원하는 만큼 추가 권한을 추가할 수 있습니다. 또한 원하는 경우 여러 계정에서 사용할 수 있는 자격 증명을 얻을 수 있습니다.

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

OpenAPI 사양 가져오기

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

OpenAPI 사양을 얻으려면 CMS API 참조그리고다운로드단추:

다운로드한 파일은 openapi.yaml

OpenAPI 사양 가져오기

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

컬렉션 설정

이제 API 사양을 가져왔으므로 요청 모음을 생성할 수 있습니다.

1. 딸깍 하는 소리아피스 .
2. 다른 API가 있는 경우 다음을 선택하십시오. Brightcove CMS API 참조
3. 딸깍 하는 소리컬렉션 생성 :

   

4. 표시되는 대화 상자에서 "Brightcove CMS API"와 같은 컬렉션 이름을 입력합니다.
5. 선택하다 API 테스트 "이 API를 어떻게 사용하시겠습니까?"
6. 딸깍 하는 소리컬렉션 생성 :

   

7. 열기컬렉션새 CMS API 컬렉션을 클릭합니다.
8. 컬렉션을 확장하고비디오폴더를 선택하고비디오 가져오기요구.

   

   

Postman은 요청 자체와 요청에 추가할 수 있는 매개변수를 포함하여 API 참조에서 대부분의 세부 정보를 설정했습니다. 또한 다음을 클릭할 수 있습니다. 선적 서류 비치 API 참조의 요청에 대한 문서를 표시하는 오른쪽 아이콘:

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

환경 만들기

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

1. 딸깍 하는 소리환경 , 그리고환경 만들기 :

   

2. 환경에 "Brightcove APIs"와 같은 이름을 지정합니다(필요에 따라 새 변수를 추가하여 다른 Brightcove API에도 이 환경을 사용할 수 있습니다).
3. "새 변수 추가" 텍스트를 클릭하고 다음을 입력합니다. 계정 ID을 클릭한 다음초기 값필드에 Video Cloud 계정 ID를 입력하십시오.

   

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"를 입력하기 시작합니다. 값경로 변수 필드계정 ID :

요청 활성화

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

1. 아직 입력하지 않았다면 다음을 입력하십시오. {{account_id}}의 가치를 위해계정 ID경로 변수 .
2. 클릭권한 부여요청 탭:

   

3. 아래에구성 옵션 , 변경보조금 유형에게클라이언트 자격 증명 :

   

4. 해당 필드에 환경의 다음 변수를 입력합니다.
   • 액세스 토큰 URL: {{access_token_url}}
   • 클라이언트 ID: {{client_id}}
   • 클라이언트 암호: {{client_secret}}
5. 딸깍 하는 소리새 액세스 토큰 받기 :

   

6. 승인이 완료되면 다음을 클릭할 수 있습니다. 진행하다또는 토큰이 나타날 때까지 기다리십시오. 그런 다음토큰 사용 :

   

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

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

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

이런 일이 발생하면 단순히권한 부여탭을 클릭하고 새 토큰을 요청하십시오. 또한 만료된 토큰은 더 이상 가치가 없으므로 혼동을 피하기 위해 삭제해야 합니다.

요청하다

이제 비디오 가져오기를 요청할 준비가 되었습니다.

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

   

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

   

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

   

7. 이 JSON은 편집할 수 있습니다. 동영상 만들기 요청의 유일한 필수 필드는이름 , 따라서 해당 값을 "Test Video"로 변경하고 요청 본문이 다음과 같이 되도록 JSON의 나머지 부분을 제거합니다.

   {
   	"name": "Test video"
   }

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

관련 주제

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