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

    API 요청에 Postman 사용

    이 주제에서는 널리 사용되는 Postman HTTP 클라이언트를 설정하여 Brightcove RESTful API에 요청하는 방법을 학습합니다. 일부는 curl 문과 명령 행을 발견하는데,이 절의 대부분의 예제에서 사용 된 어렵고 위협적인 예입니다. 이를 위해 대부분의 Brightcove API를 포함하여 HTTP 요청을 REST 기반 서비스로 전송하는 수많은 도구가 있습니다. 이 문서는 이러한 도구 중 하나 인 Postman 앱을 사용하는 방법을 보여줍니다.

    설치 우편 집배원

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

    클라이언트 자격 증명 얻기

    Brightcove API를 사용하려면 사용하려는 계정 및 API에 대한 클라이언트 자격 증명이 필요합니다. 의 지시에 따라 Studio에서 클라이언트 자격 증명을 얻습니다. API 인증 자격 증명 관리. 아래 단계에서 우리는 Player Management API 요청을 사용하여 우편 집배원따라서 자격 증명에 적어도 다음 사용 권한이 있어야합니다.

    • Players: Read/Write

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

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

    사용 우편 집배원

    클라이언트 자격 증명이 있으면 사용을 시작할 수 있습니다 우편 집배원. 아래 단계는 일부를 만드는 과정을 안내합니다. Player Management API 요청을 사용하여 우편 집배원.

    설정 우편 집배원 액세스 토큰을 얻기 위해

    1. 를 실행 우편 집배원 응용 프로그램.
    2. 새 요청 만들기 :
      새 요청 만들기
      새 요청 만들기
    3. 새 요청 대화 상자에서 "Get Player요청 이름은 "s":
      요청 이름
      요청 이름
    4. 컬렉션 만들기를 클릭 한 다음 "Player Management API컬렉션 이름으로 "
      요청 컬렉션 만들기
      요청 컬렉션 만들기
    5. 컬렉션을 저장하십시오.
    6. 찾기 Player Management API 왼쪽 목록에있는 컬렉션을 클릭하고 클릭하여 새 요청을 엽니 다.
      Player Management API 수집
      Player Management API 수집
    7. 로 이동 권한 부여 탭에서 유형으로 OAuth 2.0를 선택하고 요청 헤더에 권한 부여 데이터 추가가 선택되었는지 확인하십시오.
      권한 부여 섹션
      권한 부여 섹션
    8. Click 하십시요. 새로운 액세스 토큰 받기:
      새로운 액세스 토큰 받기
      새로운 액세스 토큰 받기
    9. 대화 상자에서 다음 정보를 입력하십시오.
      • 토큰 이름: Player Management API
      • 부여 유형: 클라이언트 자격 증명
      • 액세스 토큰 URL: https://oauth.brightcove.com/v4/access_token
      • 고객 ID: (고객 ID 입력)
      • 고객 비밀: (고객 비밀번호 입력)
      • 범위: (백지로 둬)
      • 클라이언트 인증: 본문에 클라이언트 자격 증명을 보냅니다.
      액세스 토큰 대화 상자 가져 오기
      액세스 토큰 대화 상자 가져 오기
    10. Click 하십시요. 요청 토큰
    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 일부 데이터로 요청하십시오. 이 경우에 우리는 새로운 것을 만들 것입니다 player 를 사용하여 Player Management API.

    을 만들다 POST 의뢰

    1. Get Players 요청 복제 :
      중복 요청
      중복 요청
    2. 새 요청을 열고 이름을 "작성"으로 변경하십시오. 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. Click 하십시요. 전송.
    8. 귀하의 답변은 다음과 유사합니다 ( 예쁜 더 잘 형식화 된 JSON을위한 버튼) :

      POST 응답
      POST 응답
    9. 당신은 당신을 확인할 수 있습니다 player 체크인하여 만든 PlayerStudio의 섹션.

    환경 변수

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

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

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

    API 참조에서 컬렉션 만들기

    6.7.4 버전부터, 우편 집배원 요청 콜렉션을 작성하기 위해 OpenAPI 스펙 가져 오기를 지원합니다. Brightcove의 플랫폼 API 참조는 OpenAPI 사양을 기반으로하기 때문에이 기능을 사용하여 모든 Brightcove API에 대한 전체 요청 모음을 생성 할 수 있습니다.

    아래 단계에서 Google은 Dynamic Ingest API 예를 들어, 절차는 모든 Brightcove 플랫폼 API (지원 ...에 대한 Player API Postman은 REST API 만 지원하므로 모바일 SDK).

    단계

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

    페이지 최종 업데이트 29 Sep 2020