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

    API 요청에 우편 배달부 사용

    이 주제에서는 인기있는 Postman HTTP 클라이언트를 설정하여 Brightcove RESTful API에 요청하는 방법을 알아 봅니다. 일부는 문서의이 섹션에있는 대부분의 예제에 사용되는 curl 문과 명령 줄을 찾기가 어렵고 위협적입니다. 이를 위해 대부분의 브라이트코브 API를 포함하는 REST 기반 서비스에 HTTP 요청을 보낼 수 있는 다양한 도구가 있습니다. 이 문서는 이러한 도구 인 Postman 앱을 사용하는 방법을 보여줍니다.

    설치Postman

    가져 오기Postman ...에서www.getpostman.com . Postman Chrome 또는 Mac 앱으로 설치할 수 있습니다. 데스크톱 클라이언트를 사용하는 것이 좋지만 Chrome 버전은 모든 플랫폼에서 실행되며 기능과 모양이 동일합니다.

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

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

    • 플레이어 : 읽기 / 쓰기

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

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

    사용Postman

    클라이언트 자격 증명이 있으면 사용할 준비가 된 것입니다. Postman . 아래 단계는 몇 가지를 만드는 과정을 안내합니다. 플레이어 관리 API사용 요청Postman .

    설정Postman액세스 토큰을 얻으려면

    1. 시작Postman앱.
    2. 새 요청을 작성하십시오.
      새 요청 생성
      새 요청 생성
    3. 새 요청 대화 상자에서 요청 이름으로 "Get Players"를 입력합니다.
      요청 이름
      요청 이름
    4. 컬렉션 만들기를 클릭 한 다음 컬렉션 이름으로 "Player Management API"를 입력합니다.
      요청 수집 만들기
      요청 수집 만들기
    5. 컬렉션을 저장합니다.
    6. 왼쪽 목록에서 플레이어 관리 API 컬렉션을 찾아 클릭하여 새 요청을 엽니 다.
      플레이어 관리 API 컬렉션
      플레이어 관리 API 컬렉션
    7. 다음으로 이동권한 부여탭에서 유형으로 OAuth 2.0을 선택하고 요청 헤더에 권한 부여 데이터 추가가 선택되어 있는지 확인합니다.
      권한 부여 섹션
      권한 부여 섹션
    8. 딸깍 하는 소리새 액세스 토큰 받기 :
      새 액세스 토큰 받기
      새 액세스 토큰 받기
    9. 대화 상자에서 다음 정보를 입력하십시오.
      • 토큰 이름 : 플레이어 관리 API
      • 부여 유형 : 클라이언트 자격 증명
      • 액세스 토큰 URL : https://oauth.brightcove.com/v4/access_token
      • 클라이언트 ID : (클라이언트 ID 입력)
      • 클라이언트 비밀 : (클라이언트 비밀번호 입력)
      • 범위 : (백지로 둬)
      • 클라이언트 인증 : 본문에 클라이언트 자격 증명 보내기
      액세스 토큰 가져오기 대화 상자
      액세스 토큰 가져오기 대화 상자
    10. 딸깍 하는 소리토큰 요청
    11. 새 액세스 토큰이 표시되어야합니다.
      새 액세스 토큰
      새 액세스 토큰

    GET요청 보내기

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

    GET요청 만들기

    1. 이제 다음 URL을요청 URL 입력필드에서 {account_id}를 계정 ID로 대체 :
      	https://players.api.brightcove.com/v2/accounts/YOUR_ACCOUNT_ID/players
      	
      	
      요청 URL 입력
      요청 URL 입력
    2. 방법을 그대로 둡니다. GET을 클릭하고보내다 :
      요청 받기
      GET요청
    3. 응답은 다음과 같아야합니다.
      응답 받기
      응답 받기

    POST요청 보내기

    이제 우리는POST일부 데이터로 요청하십시오. 이 경우 플레이어 관리 API를 사용하여 새 플레이어를 만듭니다.

    POST요청 만들기

    1. Get Players 요청을 복제하십시오.
      중복 요청
      중복 요청
    2. 새 요청을 열고 이름을 "Create Player"로 바꿉니다.
      이름 바꾸기 요청
      이름 바꾸기 요청
    3. 동일한 URL을 사용하십시오. GET위의 단계를 요청했지만 이제POST선택된 HTTP 메소드가됩니다.
      요청 게시
      POST의뢰
    4. 클릭 URL 바로 아래의 탭을 클릭 한 다음노골적인라디오 버튼 및 JSON (애플리케이션 / json)유형 드롭 다운 메뉴에서 :
      요청 본문
      요청 본문
    5. 새 헤더가 요청에 자동으로 추가됨을 알 수 있습니다. 데이터를 전송하는 요청에는 어떤 종류의 데이터가 전송되는지 API에 알려주는 헤더가 필요합니다. 클릭헤더확인하려면 탭Content-Type: application/json머리글:
      머리글 추가
      머리글 추가
    6. 원시 데이터의 경우 본문에 대해 다음 JSON 코드를 입력합니다 (JSON 다음의 스크린 샷은 요청이 어떻게 표시되는지 보여줍니다).
      	{
              "name": "Postman Test Player"
              }
      	
    7. 보내기를클릭합니다.
    8. 응답은 다음과 유사합니다 (좀 더 멋지게 형식화 된 JSON을 보려면 [ 프리티 ] 버튼을 클릭 할 수 있습니다).

      POST 응답
      POST 응답
    9. Studio의 플레이어 섹션에서 플레이어가 생성되었는지 확인할 수 있습니다.

    환경 변수

    여러 계정 및 API 작업 조합에 대한 클라이언트 자격 증명을 만들 수 있지만 자격 증명 범위를 단일 계정 및 API (또는 특정 API 작업)로 제한하여 보안을 강화할 수 있습니다. 그렇다면 다음을 활용할 수 있습니다. Postman '에스환경 변수여러 계정 및 API에 대한 테스트 요청을 단순화합니다. 핵심은 사용하는 각 클라이언트 자격 증명 집합에 해당하는 환경을 설정하는 것입니다.

    다음은 환경 변수를 만들고 사용하는 단계입니다. client_id client_secret .

    1. 오른쪽 상단의 톱니 바퀴 메뉴를 클릭합니다. Postman그리고 선택환경 관리.
      환경 메뉴
      환경 메뉴
    2. 에서환경 관리대화 상자에서더하다환경을 추가합니다.
    3. 새 환경의 경우 다음을 입력하십시오.
      • 이름 (Brightcove APIS 또는 원하는대로)
      • 라는 환경 변수account_id귀하의 계정 ID 값으로
      • 라는 환경 변수client_id 클라이언트 ID 값으로
      • 라는 환경 변수client_secret 당신의 클라이언트 비밀 값으로
      환경 변수 추가
      환경 변수 추가
    4. 딸깍 하는 소리더하다환경을 추가하려면
    5. 닫기환경 관리돌아갈 대화 상자Postman메뉴에서 환경을 선택합니다.
      환경 선택
      환경 선택
    6. 이제 요청의 하드 코딩 된 값을 변수로 바꿀 수 있습니다. 이렇게하려면 다음을 입력하십시오. {{어디에서나 변수 드롭 다운 목록이 나타납니다.
      환경 변수 사용
      환경 변수 사용

    API 참조에서 컬렉션 만들기

    버전 6.7.4부터Postman요청 컬렉션을 만들기 위해 OpenAPI 사양 가져 오기를 지원합니다. Brightcove의 플랫폼 API 참조는 OpenAPI 사양을 기반으로하므로이 기능을 사용하여 Brightcove API에 대한 전체 요청 컬렉션을 생성 할 수 있습니다.

    아래 단계에서 우리는Dynamic Ingest API예를 들어 절차는 모든 Brightcove 플랫폼 API ( 아니 Postman은 REST API 만 지원하므로 Player API 또는 모바일 SDK의 경우).

    단계

    1. 브라우저에서 Dynamic Ingest API 참조
    2. 클릭Download제목 아래에있는 버튼을 클릭하여OpenAPI specification API의 경우 :
      오픈 API 사양 다운로드
      오픈 API 사양 다운로드
    3. 사용중인 브라우저에 따라 사양 (YAML 파일)이 다운로드되거나 새 브라우저 탭에서 열릴 수 있습니다. 브라우저에서 열리면 내용을 복사하여 텍스트 파일에 붙여 넣거나 페이지 소스를 로컬 드라이브에 저장하십시오. 파일 이름은openapi.yaml .
    4. 이제 이동Postman그리고Import왼쪽 창 상단의 버튼 :
      우편 배달부 가져오기 단추
      우편 배달부 가져오기 단추
    5. 드래그 앤 드롭openapi.yaml파일 관리자에서 열리는 가져 오기 모달로 파일을 엽니 다.
      우편 배달부 가져오기 모달
      우편 배달부 가져오기 모달
    6. Postman파일을 처리하면 목록에 새 컬렉션이 표시됩니다. Dynamic Ingest API Reference
      뉴 포스트맨 컬렉션
      뉴 포스트맨 컬렉션
    7. 다음을 통해 폴더로 드릴 다운accounts/{account id}/video/{video id}요청이 표시됩니다.
      요청으로 드릴다운
      요청으로 드릴다운
    8. 선택POST그것을 열 것을 요청하십시오. 둘 다 찾을 수 있습니다Params그리고Body API 참조에서 미리 채워지지만 데이터 유형을 표시하는 자리 표시자를 실제 데이터로 바꿔야합니다.
      미리 채워진 매개변수
      미리 채워진 매개변수
      미리 채워진 본문
      미리 채워진 본문
    9. 자리 표시자를 적절한 값으로 바꾼 후에는 직접 만든 것과 같은 요청을 사용할 수 있습니다.