개념: 브라이트코브 API용 테스트 도구

이 주제에서는 Brightcove RESTful API를 테스트하고 학습하는 데 도움이되도록 Brightcove Learning Services가 제공하는 도구에 대해 알아 봅니다.

도구 목록

이 가이드에서는 다음 도구에 대해 설명합니다.

API 테스트 도구
테스트 도구 API
api-tester.sh 요청을 인증하기위해 브라이트코브 OAuth를 사용하는 모든 API
온라인 테스터 요청을 인증하기위해 브라이트코브 OAuth를 사용하는 모든 API
잠 잘 수 없음 인증 방법에 관계없이 모든 REST API
우편 집배원 인증 방법에 관계없이 모든 REST API
  • macOS 또는 다른 UNIX 또는 LINUX 시스템에서 작업하거나 Windows 시스템에 cURL이설치되어 있는 경우 명령줄에서 실행할 수 있는 셸 스크립트입니다.
  • 모든 브라우저에서 작동하는 온라인 테스트 도구
  • 인기있는 Postman REST API 테스터 사용 가이드

쉘 스크립트 (cURL)

명령줄 도구는 다음과 같은 셸 스크립트입니다. api-tester.sh액세스 토큰을 얻고 API를 호출합니다. API 테스터 스크립트는 cURL을 사용하여 http 호출을 수행합니다. cURL은 Mac macOS 및 모든 유닉스/리눅스 시스템에 내장되어 있습니다. Windows에서 cURL을 가져오려면 cURL 설정을 참조하십시오 . 그런 다음 api-tester.sh 스크립트를 다운로드합니다.

셸 스크립트의 전체 코드는 액세스 토큰가져오기에서 확인할 수있습니다.

쉘 스크립트 실행

셸 스크립트를 다운로드 한 후 원하는 위치에서 압축을 푼 다음 동일한 폴더의 명령 줄로 이동합니다. 스크립트를 실행하려면 다음을 입력하십시오.

	bash api-tester.sh

스크립트를 실행할 때마다 5 개의 변수를 입력하라는 메시지가 표시됩니다.

  • 클라이언트 ID( 아래 섹션클라이언트 자격 증명 획득 시)
  • 클라이언트 암호(참조아래 섹션클라이언트 자격 증명 획득 시)
  • 전체 API 호출 (예: https://cms.api.brightcove.com/v1/accounts/12345678/videos
  • 요청 동사 - 다음 중 하나 GET | POST | 패치 | PUT | DELETE (GET이 기본값)
  • 요청 데이터 - POST, 패치 및 PUT에 사용됩니다. GET 및 DELETE 요청의 경우 이 필드를 비워 두고 Return을 누르기만 하면 됩니다.

명령 줄 도구는 다음과 같은 응답을 반환합니다. 온라인 도구 -그러나 또한 전체 응답을 에코하므로 어떤 이유로 요청이 실패 할 경우 헤더와 추가 정보를 볼 수 있습니다. 또한 응답에 대한 원시 JSON과 예쁜 인쇄 버전을 에코합니다.

온라인 도구

온라인 테스트 도구는여기에서 찾을 수있습니다. 명령 줄 도구와 마찬가지로 다음을 묻습니다.

  • 클라이언트 ID
  • 클라이언트 비밀
  • 전체 API 요청 URL
  • 요청 유형
  • 제출할 JSON 데이터 (있는 경우)

잠 잘 수 없음

Insomnia를 사용하여 API를 요청하는 방법에 대한단계별 가이드를 참조하세요 .

우편 배달부

Postman을 사용하여 API 요청을 만드는 방법에 대한단계별 가이드를 참조하십시오 .

자격 증명 얻기

브라이트코브 API를 사용하려면client_id및 로 구성된 적절한 클라이언트 자격 증명이 필요합니다client_secret . 참조 OAuth 개요클라이언트 자격 증명 흐름을 더 잘 이해할 수 있습니다.

광고를 받으려면 OAuth UI로 이동하여 앱을 등록해야 합니다. client_idclient_secret

CURL 또는 우편 배달부를 통해 자격 증명을 얻을 수도 있습니다.