Rights Locker APIリファレンス

これは、Rights LockerのAPIルートの正式な説明です。

API サーバー: rl.ooyala.com

Note: Rights Locker API へのすべてのリクエストは、 https://api.ooyala.com ではなく、サーバーhttp://rl.ooyala.comに行なってください。

MIMEタイプ

権限を作成するためにPOSTを実行する時、次のようにMIMEタイプを 設定してください。
Content-type: application/json

権限の作成

POSTボディのラベルの発行ルールとラベルの識別子で権限を作成します。

[POST] /v2/entitlements/providers/provider_id/accounts/account_id/content
{      
     <Example of POST body>
}               
            

呼び出しに成功した場合、レスポンスボディは返りません。HTTPレスポンスコード200を確認してください。

権限の取得

一般的に権限の取得には2通りあります。
  1. アカウントのすべての権限を取得
  2. アセットIDまたはラベルIDで特定の権限を取得

メソッド#1。アカウントのすべての権限を取得

[GET] /v2/entitlements/providers/provider_id/accounts/account_id/content

メソッド#2。特定のアセットの権限を取得

[GET] /v1/entitlements/providers/provider_id/accounts/account_id/content/assets/asset_id/external_products/external_product_id

メソッド#2:特定のラベルの権限を取得

[GET] /v1/entitlements/providers/provider_id/accounts/account_id/content/labels/label_id/external_products/external_product_id

権限の削除

アカウント権限すべて、または特定のアセットやラベルの権限を削除できます。

ユーザーaccount_idの権限をすべて削除します。

[DELETE] /v2/entitlements/providers/provider_id/accounts/account_id/content

呼び出しに成功した場合、レスポンスボディは返りません。

asset_idで識別されるコンテンツに対するユーザーaccount_idの権限を削除します。

Note: ラベルとその継承の階層的な性質のため、ラベル階層で低い位置にある権限を 削除しても、権限が階層上部にまだ存在する場合、効果がありません。したがって、ユーザーの特定の権限を削除する際、ユーザーが階層 上部に権限を持っていないかを確認してください。もし上部にもあるなら、 その権限も削除してください。
[DELETE] /v2/entitlements/providers/provider_id/accounts/account_id/content/assets/asset_id/external_products/external_product_id

呼び出しに成功した場合、レスポンスボディは返りません。

label_idで識別されるコンテンツへのユーザーaccount_idの権限を削除します。

Note: ラベルとその継承の階層的な性質のため、ラベル階層で低い位置にある権限を 削除しても、権限が階層上部にまだ存在する場合、効果がありません。したがって、ユーザーの特定の権限を削除する際、ユーザーが階層 上部に権限を持っていないかを確認してください。もし上部にもあるなら、 その権限も削除してください。
[DELETE] /v2/entitlements/providers/provider_id/accounts/account_id/content/labels/label_id/external_products/external_product_id

権限の更新

権限の更新には、作成時に使用したPOSTメソッドを使用してください。label_id、 user_id、external_product_idのユニークな組み合わせが既存の権限に一致する場合、 更新します。

POSTボディの例

アセットまたはラベルのどちらかで権限を定義できます。POSTボディには、両方またはその どちらかを含むことができます。どちらのタイプもプロパティは同一です。

注: ラベルやアセットの識別子をルート自体に含める場合、POSTボディに識別子を 含める必要はありません。
        
{
 “assets” : 	[
     { “content_id” : “an_embed_code”,
       “publishing_rule_id” : “publishing_rule_id”,
       “external_product_id” : “your_product_id”,
       “start_time” : YYYYMMDD,
       “end_time” : YYYYMMDD,
     },
     { “content_id” : “another_embed_code”,
          .
          .
          .                        
          },
     .
     . 
     .
     ],
 “labels” :	[
     { “content_id” : “a_label_id”,
       “publishing_rule_id” : “publishing_rule”,
       “external_product_id” : “your_product_id”,
       “start_time” : YYYYMMDD,
       “end_time” : YYYYMMDD
     },
     { “content_id” : “another_label_id”,
          .
          .
          .                        
          },
     .
     . 
     .
     ]
}
   

レスポンス

Rights Lockerは、Backlotが返すHTTPレスポンスコードと同じものを返しますが、次のような例外があります。
  • POSTを通じて作成に成功すると、 200 HTTPレスポンスが返されますが、レスポンスボディに データは含まれません。
  • 権限を検索(GETを通じて)して一致する結果がない場合、 Rights Lockerは404"Not found"を返します。

プロパティ

次の表は権限と関連付けることができるすべてのプロパティを示しています。

プロパティ

説明

必須?

asset_id

権限が付与されたコンマ区切りのアセット一覧。
注: Rights Lockerで外部識別子を使うことはできません。渡された値は実際のembedコード(アセットID)である 必要があります。

タイプ:文字列

いいえ

content_id

アセット(asset_idまたはembed_code) かラベルの識別子。

はい

end_time

権限の期限終了時間

タイプ: dateTime

例:2013-08-31T23:59:59

デフォルト:省略すると権限の期限はなくなります。

いいえ

external_product_id

この権限を適用する製品独自の識別子。

タイプ:文字列

有効な値: 予約されているURL関連文字を含めないでください([ /や | ]など)。

最大文字数:254文字

はい

labels

権限が付与されたコンマ区切りのラベル一覧。

いいえ

publishing_rule_id

コンテンツにアクセスする時のユーザー権限の追加制限。

はい

start_time

権限の期限開始時間。

タイプ: dateTime

例:2013-08-01T00:00:00

デフォルト:省略すると、権限はすぐに有効になります。

いいえ

num_devices_to_bind 視聴者ごとの使用可能デバイス数の上限 いいえ

ルート属性

次の属性はAPIコールで必要になります。
表 1.
プロパティ 定義
account_id

お客様のためのユニークな識別子

タイプ:文字列

有効な値: 予約されているURL関連文字を含めないでください([ /や | ]など)。

最大文字数:254文字

provider_id コンテンツプロバイダーのユニークな識別子。Backlot UIアカウントタブ、 開発者サブタブ、 パートナーコード: フィールで確認可能。

external_product_id

製品独自のユニークな識別子。

タイプ:文字列

有効な値: 予約されているURL関連文字を含めないでください([ /や | ]など)。

最大文字数:254文字

label_id

ラベルのユニークな識別子。

タイプ:文字列

この記事はお役にたちましたか?