コンテンツ配信用のREST API

機械翻訳について

プロバイダ・トークンの生成

post

/content/published/api/v1.1/items/{id}/providerTokens

パブリッシュされたアセット用。

リクエスト

サポートされているメディア・タイプ

application/json

パス・パラメータ

id: string

アイテムの一意の識別子(ID)。

問合せパラメータ

channelToken(optional): string

パブリッシュ・ターゲットのチャネル・トークン。チャネル・トークンは、問合せパラメータまたはリクエスト・ヘッダーのいずれかとして提供する必要があります。

ヘッダー・パラメータ

X-Requested-With: string

CSRF攻撃を軽減するためのカスタム・ヘッダー。

許容値: [ "XMLHttpRequest" ]

プロバイダ・トークン・リクエストを生成するモデル・クラス

ルート・スキーマ : ProviderToken

型: object

ProviderToken

Show Source

permissions(optional): array permissions

トークンの生成に使用する権限。有効な権限は次のとおりです: 表示、ダウンロード、コントリビュートおよび管理
provider: object Provider

プロバイダ
scope(optional): object scope

許可される追加プロパティ: additionalProperties

トークンが生成されるターゲットを将来識別するプロバイダ固有のプロパティ
token(optional): string

読取り専用: true

生成されるトークン値

{
    "type":"object",
    "required":[
        "provider"
    ],
    "properties":{
        "provider":{
            "description":"provider for which a token is to be generated",
            "$ref":"#/definitions/Provider"
        },
        "permissions":{
            "type":"array",
            "description":"permissions with which a token is to be generated; valid permissions are: view, download, contribute, and manage",
            "items":{
                "type":"string"
            }
        },
        "scope":{
            "type":"object",
            "description":"provider specific properties to future identify a target for which a token is to be generated",
            "additionalProperties":{
                "type":"object"
            }
        },
        "token":{
            "type":"string",
            "description":"generated token value",
            "readOnly":true
        }
    },
    "description":"ProviderToken"
}

ネストされたスキーマ : 許可

型: array

トークンの生成に使用する権限。有効な権限は次のとおりです: 表示、ダウンロード、コントリビュートおよび管理

Show Source

Array of: string

{
    "type":"array",
    "description":"permissions with which a token is to be generated; valid permissions are: view, download, contribute, and manage",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ : プロバイダ

型: object

プロバイダ

Show Source

name: string

プロバイダ名

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"provider name"
        }
    },
    "description":"Provider"
}

ネストされたスキーマ : scope

型: object

使用可能なその他のプロパティ

Show Source

object additionalProperties

{
    "type":"object",
    "description":"provider specific properties to future identify a target for which a token is to be generated",
    "additionalProperties":{
        "type":"object"
    }
}

トークンが生成されるターゲットを将来識別するプロバイダ固有のプロパティ

ネストされたスキーマ : additionalProperties

型: object

トップに戻る

レスポンス

サポートされているメディア・タイプ

application/json

200レスポンス

操作の成功

ルート・スキーマ : ProviderToken

型: object

ProviderToken

Show Source

permissions(optional): array permissions

トークンの生成に使用する権限。有効な権限は次のとおりです: 表示、ダウンロード、コントリビュートおよび管理
provider: object Provider

プロバイダ
scope(optional): object scope

許可される追加プロパティ: additionalProperties

トークンが生成されるターゲットを将来識別するプロバイダ固有のプロパティ
token(optional): string

読取り専用: true

生成されるトークン値

{
    "type":"object",
    "required":[
        "provider"
    ],
    "properties":{
        "provider":{
            "description":"provider for which a token is to be generated",
            "$ref":"#/definitions/Provider"
        },
        "permissions":{
            "type":"array",
            "description":"permissions with which a token is to be generated; valid permissions are: view, download, contribute, and manage",
            "items":{
                "type":"string"
            }
        },
        "scope":{
            "type":"object",
            "description":"provider specific properties to future identify a target for which a token is to be generated",
            "additionalProperties":{
                "type":"object"
            }
        },
        "token":{
            "type":"string",
            "description":"generated token value",
            "readOnly":true
        }
    },
    "description":"ProviderToken"
}

ネストされたスキーマ : 許可

型: array

トークンの生成に使用する権限。有効な権限は次のとおりです: 表示、ダウンロード、コントリビュートおよび管理

Show Source

Array of: string

{
    "type":"array",
    "description":"permissions with which a token is to be generated; valid permissions are: view, download, contribute, and manage",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ : プロバイダ

型: object

プロバイダ

Show Source

name: string

プロバイダ名

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"provider name"
        }
    },
    "description":"Provider"
}

ネストされたスキーマ : scope

型: object

使用可能なその他のプロパティ

Show Source

object additionalProperties

{
    "type":"object",
    "description":"provider specific properties to future identify a target for which a token is to be generated",
    "additionalProperties":{
        "type":"object"
    }
}

トークンが生成されるターゲットを将来識別するプロバイダ固有のプロパティ

ネストされたスキーマ : additionalProperties

型: object

400レスポンス

不正リクエスト。サーバーは、不正な構文、無効なデータまたはメッセージ・フレーミングのために、クライアント側でリクエストを処理できません。

403レスポンス

禁止。クライアントはこのリクエストを実行する権限がありません。

404レスポンス

リクエストされたリソースは見つかりませんでした。

500レスポンス

内部サーバー・エラーシステムで予期しないエラーが発生しました。

トップに戻る

例

次の例では、パブリッシュされたアセットのプロバイダ・トークンを作成する方法を示します。

curl -i -X POST -H 'Content-Type:application/json' -H 'X-Requested-With: XMLHttpRequest' 'http://<hostname>/content/published/api/v1.1/items/{id}/providerTokens'

例1

これにより、IDがCONTB94719ABE603404BAE0D808C59989FF9のパブリッシュ済アセットのkalturaプロバイダ・プレビュー・トークンが生成されます。

/content/published/api/v1.1/items/CONTB94719ABE603404BAE0D808C59989FF9/providerTokens?channelToken=d20844efa0d143f8b343e0aaeb4d2caf

リクエスト・ペイロード

{
  "provider": {
    "name": "kaltura"
  },
  "scope": {
    "entry": {
      "id": "0_8t3brdui"
    }
  }
}

リクエスト・ヘッダー

{
  "Content-Type": "application/json",
  "X-Requested-With": "XMLHttpRequest"
}

レスポンス本文

{
  "provider": {
    "name": "kaltura"
  },
  "permissions": [
    "view"
  ],
  "token": "djJ8MjcwNTc3MnyrFUVElvYu5GMYZJQOUMjTloB-oN2EbZ325YuunBinE4XNsCgY4H5p5-oZ-qES7OSUWBljkVrKIX6lZ9qwc3VVmkvo0WlExGHOaxEdhIlB_iwZrBqoTaGD8RE2y-6uKMjRBdB5XI23fa7FuB6vH2g0"
}

トップに戻る