入門
Ingest Profiles API を使用すると、次のことができます。
-
アカウントのプロファイルを入手する
-
新しいプロファイルの作成
-
プロファイルを更新する
-
プロファイルを削除する
-
アカウントのデフォルトプロファイルを設定または更新する
安らかなAPI
Ingest Profiles API は RESTful API です。HTTPS リクエストを受け入れ、JSON レスポンスを返します。
つまり、Ruby、Java、PHP、Python、JavaScript(AJAXまたはnodejs経由)など、選択した任意の言語で API を使用できることを意味します。HTTPS リクエストを作成し、JSON レスポンスを処理することだけを行うことができます。
ベースURL
Ingest ProfilesAPIのベースURLは次のとおりです。
https://ingestion.api.brightcove.com/v1
認証
API 呼び出しは OAuth2 アクセストークンを使用して許可されます。トークンは、認証ヘッダー内の要求とともに渡されます。
Authorization: Bearer {access_token}
アクセストークンは短命(5分)なので、リクエストを行うたびにトークンを取得する必要があります
これらの演習では、次の方法でリクエストを行います。プロキシアクセストークンを取得してからリクエストを行います。
演習のセットアップ
セットアップ
2つのオプションがあります。
- サンプルアカウントで演習を実行する(推奨)
- 自分のアカウントを使用する
すべてのプロファイルを取得する
アカウントプロファイルの取得
アカウントのすべてのプロファイルを取得するには、エンドポイントにGETリクエストを送信します。
/accounts/{account_id}/profiles
例:
https://ingestion.api.brightcove.com/v1/accounts/57838016001/profiles
演習1:演習1:すべてのプロファイルを取得
次のGETリクエストを行います。
プロファイルの作成
プロファイルの作成
プロファイルを作成するには、エンドポイントにPOSTリクエストを送信します。
/accounts/{account_id}/profiles
例:
https://ingestion.api.brightcove.com/v1/accounts/57838016001/profiles
プロファイルのJSONは、リクエストの本文として含まれています。を参照してくださいプロファイルフィールドリファレンスプロファイル、レンディション、およびDRMパッケージフィールド用
演習2:演習2:プロファイルの作成
次のPOSTリクエストを行います。
演習2の応答
単一のプロファイルの取得
IDでプロファイルを取得する
IDでプロファイルを取得するには、エンドポイントに対してGETリクエストを行います。
/accounts/{account_id}/profiles/{profile_id}
ではprofile_id
、次のいずれかを使用できます。
- 名前(バランス高精細など)
- 生成されたID(例:54de14cce4b0a6d2bf9cb08a)
例:
https://ingestion.api.brightcove.com/v1/accounts/57838016001/profiles/screencast
https://ingestion.api.brightcove.com/v1/accounts/57838016001/profiles/54de14cce4b0a6d2bf9cb08a
演習3:1つのプロファイルを取得
作成したプロファイルを取得するには、次のGETリクエストを実行します。
プロファイルの更新
IDでプロファイルを更新する
IDでプロファイルを更新するには、エンドポイントにPUTリクエストを送信します。
/accounts/{account_id}/profiles/{profile_id}
ではprofile_id
、次のいずれかを使用できます。
- 名前(バランス高精細など)
- 生成されたID(例:54de14cce4b0a6d2bf9cb08a)
例:
https://ingestion.api.brightcove.com/v1/accounts/57838016001/profiles/my-test-profile
プロファイルを作成したときと同じように、プロファイルデータをリクエスト本文に含めます。プロファイルデータしなければならない含めるid
プロフィールのために!
演習4:演習4:プロファイルを更新する
次のPUTリクエストを実行して、作成したプロファイルを更新します(説明が更新されます)。
演習4の応答
プロファイルの削除
IDでプロファイルを削除する
IDでプロファイルを削除するには、エンドポイントに対してDELETE要求を行います。
/accounts/{account_id}/profiles/{profile_id}
ではprofile_id
、次のいずれかを使用できます。
- 名前(バランス高精細など)
- 生成されたID(例:54de14cce4b0a6d2bf9cb08a)
例:
https://ingestion.api.brightcove.com/v1/accounts/57838016001/profiles/my-test-profile
演習5:プロファイルの削除
作成したプロファイルを更新するには、次のDELETEリクエストを実行します(元に戻すことはできません!)。
デフォルトプロファイルの取得
デフォルトのプロファイルを取得する
アカウントのデフォルトプロファイルを取得するには、エンドポイントにGETリクエストを送信します。
/accounts/account_id/configuration
例:
https://ingestion.api.brightcove.com/v1/accounts/57838016001/configuration
演習6:デフォルトのプロファイルを取得する
アカウントのデフォルトプロファイルを取得するには、次のGETリクエストを実行します。
デフォルトプロファイルの設定
デフォルトプロファイルの設定
アカウントのデフォルトプロファイルを設定するには、エンドポイントにPOSTリクエストを送信します。
/accounts/account_id/configuration
リクエスト本文としてこの JSON を含める
{
"account_id": {account_id},
"default_profile_id": {default_profile_id}
}
他の操作と同様に、の名前または ID を使用できますprofile_id
。
- 名前(バランス高精細など)
- 生成されたID(例:54de14cce4b0a6d2bf9cb08a)
例:
https://ingestion.api.brightcove.com/v1/accounts/57838016001/configuration
演習7:デフォルトのプロファイルを設定する
次のPOSTリクエストを実行して、デフォルトのプロファイルを設定します(アカウントに既にデフォルトのプロファイルがある場合、これは失敗することに注意してください。次の演習でデフォルトを更新します)。
演習7の応答
デフォルトプロファイルの更新
既定のプロファイルを更新する
アカウントのデフォルトプロファイルを更新するには、エンドポイントにPUTリクエストを送信します。
/accounts/account_id/configuration
リクエスト本文としてこの JSON を含める
{
"id": {configuration_id},
"account_id": {account_id},
"default_profile_id": {default_profile_id}
}
デフォルトのプロファイルを取得すると、構成IDが返されます。デフォルトのプロファイルがない場合は、を参照してください。デフォルトプロファイルの設定。他の操作と同様に、の名前または ID を使用できますprofile_id
。
- 名前(例:高解像度)
- 生成されたID(例:54de14cce4b0a6d2bf9cb08a)
例:
https://ingestion.api.brightcove.com/v1/accounts/57838016001/configuration
演習8:デフォルトプロファイルを更新する
アカウントのデフォルトプロファイルを更新するには、次のPUTリクエストを実行します。