サポート サポートへのお問い合わせ | システムステータス システムステータス
ページコンテンツ

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

    このトピックでは、リポジトリと呼ばれるファイルのグループの管理と展開を可能にする配信システム API の概要を説明します。このシステムは、カスタムビルドプラグインの JavaScript ファイルや CSS ファイルなど、プレーヤー関連のファイルの保存領域としてセットアップされました。

    概要

    デリバリーシステムに関連付けられたファイルは、REST APIを介して、オプションでGitを介して管理されます。これらのファイルはに配信されますplayer.brightcove.net API呼び出しまたは「gitpush」のいずれかを介して。

    あなたが通過していない場合ステップバイステップ:配信システムAPI、そこから始めることを強くお勧めします。セキュリティを設定し、システムの基本をいくつか学び、ここでさらに詳しく説明します。

    API リファレンス」も参照してください。

    デリバリーシステムRESTAPI

    配信システムAPIは、リポジトリとも呼ばれるリポジトリを中心としています。リポジトリを追加、取得、一覧表示できるRESTAPIのグループを介してリポジトリを管理できます。REST API呼び出しを使用して、リポジトリ内のファイルを操作することもできます。

    コマンドラインツールcurlを使用してRESTAPIを使用できます。REST APIは、成功に関する次の情報を含むJSON形式で応答を返します。

    • name:リポジトリ名。これは、REST APIURLにある名前と同じです。
    • public_URL:リポジトリファイルを表示できるベースURL。

    ザ・ステップバイステップ:デリバリーシステム Delivery SystemAPIを使用するためのハンズオンガイドを提供します。

    認証

    どちらかを使用して自分自身を承認できます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:すべてのリポジトリの取得中にエラーが発生しました
    • UNCAUGHT_ERROR:キャッチされなかったエラーが原因で問題が発生した
    • UNKNOWN_ERROR:エラーコードが関連付けられていないエラーが発生しました

    制約事項