지원 지원 문의 | 시스템 상태 시스템 상태

API 요청에 불면증 사용

이 주제에서는 널리 사용되는 Insomnia HTTP 클라이언트를 설정하여 Brightcove RESTful API에 요청하는 방법을 학습합니다.

소개

일부는 curl 문과 명령 행을 찾아서, 플랫폼 API 문서의 많은 예제에 사용되며 어렵고 위협적입니다. 이를 위해 대부분의 Brightcove API를 포함하여 HTTP 요청을 REST 기반 서비스로 전송하는 수많은 도구가 있습니다. 이 문서는 널리 사용되는 도구 중 하나 인 Insomnia.

설치 Insomnia

도망 Insomniahttps://insomnia.rest. Insomnia Mac, Linux 또는 Windows 시스템에 설치할 수 있습니다.

Insomnia Brightcove의 RESTful API를 요청하는 데 사용할 수 있습니다. 대부분의 API는 인증에 OAuth2를 사용하므로이 문서에서 설명합니다. 그러나 적절한 헤더를 설정하여 OAuth를 사용하지 않는 API에도 사용할 수 있습니다.

불면증에 헤더 설정
헤더 설정 Insomnia

다음은 다양한 인증 방법을 사용하는 요청에서 해당 헤더가 어떻게 보이는지입니다.

OAuth API (신임장 요청 작성 )
  Authorization: BC_TOKEN YOUR_BC_TOKEN

당신을 얻는 방법 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에 대한 클라이언트 자격 증명이 필요합니다. 의 지시에 따라 Studio에서 클라이언트 자격 증명을 가져옵니다. API 인증 자격 증명 관리. 아래 단계에서 우리는 Player Management API 요청을 사용하여 Insomnia따라서 자격 증명에 적어도 다음 사용 권한이 있어야합니다.

  • 선수: 읽기 / 쓰기

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

사용 Insomnia

클라이언트 자격 증명이 있으면 사용을 시작할 수 있습니다 Insomnia. 아래의 단계는 Player Management API 요청을 사용하여 Insomnia.

설정 Insomnia 작업 공간

다른 API를 사용하는 경우 Brightcove 요청에 대해서만 작업 공간을 작성할 수 있습니다.

  1. 를 실행 Insomnia 응용 프로그램.
  2. 옆에있는 드롭 다운을 클릭하십시오. Insomnia 선택 새 작업 영역:
    작업 영역 만들기
    Insomnia 권한 부여 섹션
  3. 이름 입력 Brightcove 클릭 만들기:
    이름 작업 영역
    권한 부여 유형
  4. 클릭 더하기 부호 선택 새 폴더:
    새 폴더 만들기
    새 폴더 만들기
  5. 폴더 이름 지정 Player Management API

전송 GET 의뢰

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

을 만들다 GET 의뢰

  1. 새 폴더의 드롭 다운 메뉴 아이콘을 클릭하고 새로운 요청:
    새로운 요청
    새로운 요청
  2. 요청에 이름을 지정하십시오. 모든 것을 가져라 Players, HTTP 메소드를 다음과 같이 둡니다. GET, 작성을 클릭하십시오.
  3. 일반 요청 URL을 다음으로 대체하십시오.
      https://players.api.brightcove.com/v2/accounts/account_id/players

    교체 계정 ID 내 계정 ID :

    새 요청
    새로운 요청
  4. 확장 인증 드롭 다운 메뉴 및 선택 OAuth 2.0:
    인증 메뉴
    인증 메뉴
  5. 다음 부여 유형, 고르다 클라이언트 자격 증명:
    부여 유형
    부여 유형
  6. 액세스 토큰 URL, 클라이언트 ID 및 클라이언트 비밀 값을 입력하십시오.
    OAuth 항목
    액세스 토큰 URL https://oauth.brightcove.com/v4/access_token
    고객 ID 고객 ID
    고객 비밀 고객의 비밀
  7. Click 하십시요. 토큰 가져 오기 이 기능이 작동하는지 확인하십시오. 다음과 같은 응답이 표시됩니다.
    액세스 토큰
    액세스 토큰
  8. Click 하십시요. 전송:
    GET 요청
    GET 의뢰
  9. 응답은 다음과 같아야합니다.
    응답 받기
    GET 응답

전송 POST 의뢰

이제 우리는 POST 일부 데이터 요청. 이 경우, 우리는 새로운 비디오 객체를 만들 것입니다. Player Management API.

이렇게하기 위해 우리는 모든 것을 가져라 Players 요청하고 수정해야합니다. 또 다른 좋은 점은 Insomnia 요청을 복제 할 때 모든 인증 정보가 함께 복제되므로 액세스 토큰을 다시 설정할 필요가 없습니다.

을 만들다 POST 의뢰

  1. 온 클릭 Player Management API 폴더를 표시합니다. 모든 것을 가져라 Players 그 안에 요청하십시오.
  2. 드롭 다운 메뉴를 확장합니다. 모든 것을 가져라 Players 요청 및 선택 복제:
    중복 요청
    중복 요청
  3. 이름을 두 번 클릭하십시오. 모든 것을 가져라 Players (복사) 그것을 다음으로 변경하십시오. 만들기 Player
  4. 위의 GET 요청 단계와 동일한 URL을 사용하지만 이제는 POST 선택된 HTTP 메소드가됩니다.
    메도 변경
    방법 변경
  5. 클릭 신체 드롭 다운 메뉴를 확장하고 선택합니다. JSON:
    바디 유형 선택
    바디 유형 선택
  6. 다음 신체 데이터에 JSON 코드를 입력하십시오 (JSON 다음의 스크린 샷은 요청이 어떻게 나타나는지 보여줍니다).
      {
      "name": "MySamplePlayer",
          "configuration": {
              "media": {
              "sources": [{
                  "src":"http://solutions.brightcove.com/bcls/assets/videos/Tiger.mp4",
                  "type":"video/mp4"
                  }]
              }
          }
      }
      
      
      {
          "name": "MySamplePlayer",
          "configuration": {}
      }
      
      
    요청 본문
    요청 본문
    요청 본문
    요청 본문
  7. Click 하십시요. 전송.
  8. 귀하의 답변은 다음과 유사합니다 ( 예쁜 더 잘 형식화 된 JSON을위한 버튼) :

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

환경 변수

사용하는 것이 도움이 될 수 있습니다. Insomnia's 환경 다른 API에 대한 OAuth 자격 증명을 저장하거나 계정 ID 및 비디오와 같은 다른 정보를 저장하거나 player 아이디.

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

  1. Click 하십시요. 환경 없음 왼쪽 위의 Insomnia 드롭 다운 메뉴를 확장하고 선택합니다. 환경 관리.
    환경 메뉴
    환경 메뉴
  2. 에서 환경 관리 대화 상자에서 + 옆에 사인 하위 환경 드롭 다운 메뉴를 확장하고 환경 새로운 환경을 만드는 방법 :
    환경 추가
    환경 추가
  3. 을 두 번 클릭 새로운 환경 그것을 바꿀 이름 Player Management API (또는 원하는대로).
  4. JSON 환경의 중괄호 안에 다음 키 - 값 쌍을 추가하십시오.
    • "account_id""내 계정 ID"
    • "client_id""고객 ID"
    • "client_secret""고객의 비밀"

    작업이 끝나면 JSON은 다음과 같이 보입니다.

    환경 추가 JSON
    환경 추가 JSON

    보안상의 이유로 여기에있는 클라이언트 비밀이 희미합니다.

  5. Click 하십시요. 끝난 환경을 추가
  6. Click 하십시요. 환경 없음 다시 드롭 다운을 확장하고 용도 Player 관리 환경 (또는 새로운 환경에 부여한 이름) :
    환경 선택
    환경 선택
  7. 이제 모든 것을 가져라 Players 다시 요청하여 다시 엽니 다.
  8. Click 하십시요. OAuth 2 인증 섹션을 다시여십시오.
  9. 클라이언트 ID 값을 삭제하고 타이핑을 시작하십시오. CLIENT_ID - 관련 환경 변수를 표시하는 드롭 다운 메뉴가 나타납니다. 여기서 선택해야합니다. CLIENT_ID:
    환경 변수 드롭 다운
    환경 변수 드롭 다운
  10. 이제 계정 ID 요청 URL에 추가하고 계정 ID 변하기 쉬운.
  11. 같은 것을 바꾸어서 고객 비밀 가치있는 client_secret 변하기 쉬운.
  12. 지금 클릭 전송 요청이 여전히 작동하는지 다시 확인하십시오.

결론

이제 사용의 기본 사항을 알 수 있습니다. Insomnia Brightcove API에 요청합니다. 무료 업그레이드를 선택한 경우 Insomnia 계정을 팀 계정에 추가하면 모든 요청과 환경을 동기화하고 다른 팀 구성원과 공유 할 수도 있습니다.


12 년 2020 월 XNUMX 일에 마지막으로 업데이트 된 페이지