개요
Delivery System과 관련된 파일은 REST API 및 선택적으로 Git을 통해 관리됩니다. 이러한 파일은 API 호출 또는 “git push”를 통해 players.brightcove.net으로 전송됩니다.
단계별 과정을 거치지 않은 경우: 전달 시스템 API , 거기서부터 시작하는 것이 좋습니다. 보안을 설정하고 시스템의 기본 사항 중 일부를 배운 다음 여기에서 더 자세히 살펴볼 수 있습니다.
전달 시스템 REST API
전달 시스템 API는 리포지토리 (또는 리포지토리라고도 함)를 중심으로합니다. 저장소를 추가, 가져 오기 및 나열 할 수있는 REST API 그룹을 통해 저장소를 관리 할 수 있습니다. REST API 호출을 사용하여 repos의 파일을 조작 할 수도 있습니다.
명령 줄 도구 curl을 사용하여 REST API를 사용할 수 있습니다. REST API는 성공에 대한 다음 정보를 포함하는 JSON 형식으로 응답을 반환합니다.
- 이름: 리포지토리 이름입니다. 이는 REST API URL에있는 이름과 동일합니다.
- 공개_URL: 리포지토리 파일을 볼 수 있는 기본 URL입니다.
단계별로: 배달 시스템 Delivery System API 사용에 대한 실습 가이드를 제공합니다.
인증
OAuth 액세스 토큰을사용하거나 Brightcove 사용자 이름 및 암호를 사용하는 기본 인증을 통해 자신을 인증할 수 있습니다. 표준 OAuth 액세스 토큰은 API의 모든 프로그래밍 방식 사용에 사용해야하지만 기본 인증 경로는 명령 줄 사용 및 시작에 훨씬 더 쉽습니다.
단계별예제에서는 기본 인증을 사용하겠습니다. 대신 액세스 토큰을 사용하려면 다음을 변경하십시오.
--user $EMAIL
에:
--header "Authorization: Bearer $ACCESS_TOKEN"
API 오류 응답
REST API 호출에 문제가있을 때 JSON 형식으로 반환 될 수있는 여러 가지 오류 응답이 있습니다.
- 기존 API 호출의 철자 오류를 포함하여 존재하지 않는 API를 호출하려고하면 상태 코드 404와 잘못된 작업에 대한 유용한 메시지가 표시됩니다.
- 통화를 인증하거나 승인 할 수없는 경우 403 상태 코드를 받게됩니다. OAuth 가이드를 다시 검토하여 유효한 액세스 토큰이 있는지 확인하세요.
- GET 또는 PUT 이외의 방법을 사용하려고하면 응답에 405 상태 코드가 포함됩니다.
- 요청 처리에 문제가있는 경우 500 상태 코드와 표준 Brightcove 오류 응답을 받게됩니다.
위에서 언급 한 표준 Brightcove 오류 응답은 error_code 및 메시지 속성을 포함하는 JSON 응답입니다. 오류 코드는 다음 중 하나입니다.
INVALID_LOGIN_CREDENTIALS: 기본 인증을 사용할 때 입력한 사용자 이름과 암호가 유효하지 않습니다.ACCESS_TOKEN_ERROR: 제공된 액세스 토큰이 유효하지 않습니다INVALID_API_CALL: API 호출 형식이 제대로 지정되지 않았습니다.NOT_FOUND: API 호출이 알려진 리소스를 가리키지 않았거나 형식이 제대로 지정되지 않았습니다.- :
NO_PUT_CONTENTS리포지토리 파일을 올리려면 목차 키가 있는 여러 부분으로 구성된 양식을 사용해야 합니다. CREATE_REPO_ERROR: 리포지토리를 만드는 중 오류가 발생했습니다.GET_REPO_ERROR: 리포지토리를 가져오는 동안 오류가 발생했습니다.GET_REPOS_ERROR: 모든 저장소를 가져오는 동안 오류가 발생했습니다.UNCAUGHT_ERROR: 포착되지 않은 오류로 인해 문제가 발생했습니다.UNKNOWN_ERROR: 관련 오류 코드가 없는 오류가 발생했습니다.