サポート サポート問い合わせ先 | システムステータス システムステータス

概要:デリバリシステム API

このトピックでは、 Delivery System APIsは、リポジトリと呼ばれるファイルのグループの管理と配備を可能にします。 このシステムは、 player カスタムビルドプラグイン用のJavaScriptおよびCSSファイルなどの関連ファイル。

概要

配信システムに関連付けられたファイルは、REST APIを介して管理されます。必要に応じてGitによって管理されます。 これらのファイルは players.brightcove.net API呼び出しまたは "git push"のいずれかを使用します。

あなたが ステップバイステップ: Delivery System APIあなたがそこから始めることを強くお勧めします。 セキュリティを設定し、システムの基本を学び、ここでさらに深く掘り下げて準備しましょう。

また、 APIリファレンス.

デリバリシステムREST API

デリバリシステム API はリポジトリを中心に構成されており、repos (保管場所)とも呼ばれます。ユーザーは REST API を使用してリポジトリの追加、取得、リスト化を行うことができます。なお、REST API コールを使用してリポジトリ内のファイルを操作することもできます。

またその他、コマンドラインツールである cURL でも REST API を操作することが可能です。リクエストした場合、REST API は JSON 形式にて以下の情報を含むレスポンスを返します。

  • name:リポジトリ名。これは、REST API の URL 内にある名前と同じです。
  • public_url:リポジトリファイルを確認可能な base URL

挽き目 ステップバイステップ:デリバリーシステム 使用方法に関する実践的なガイドを提供します。 Delivery System APIs.

認証

いずれかを使用して自分自身を認証することができます OAuthアクセストークン または、Brightcoveのユーザー名とパスワードを使用して基本認証を介して。 APIのプログラムによる使用には、標準のOAuthアクセストークンを使用する必要がありますが、基本認証ルートは、コマンドラインでの使用や使用を開始する場合にはるかに簡単です。

私たちは基本認証を ステップバイステップ 例。 代わりにアクセストークンを使用する場合は、次のように変更します。

    --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:リポジトリファイルをPUTするには、コンテンツキーを持つ複数パート形式を使用する必要があります
  • CREATE_REPO_ERROR:レポの作成中にエラーが発生しました
  • GET_REPO_ERROR:レポを取得中にエラーが発生しました
  • GET_REPOS_ERROR:すべてのreposを取得中にエラーが発生しました
  • UNCAUGHT_ERROR:キャッチされていないエラーが原因で失敗しました
  • UNKNOWN_ERROR:関連するエラーコードを持たないエラーが発生しました

制限事項


ページの最終更新日:12年2020月XNUMX日