機械翻訳について
  1. コンテンツ・プレビュー用のREST API REST API
  2. チャネル・トークンと認証

チャネル・トークンと認証

アイテム・リソースのプレビューでは、まだ公開されていないリビジョン内のアセットを、公開済コンテキストで他のアセットとともにアクセス中であるかのようにプレビューできます。 これらのリソースにより、指定したチャネルをターゲットとする管理アイテムの最新バージョンをプレビューできます。 これらのリソースにアクセスするには、チャネル・トークンが必要です。 チャネル・トークンは、アイテムのターゲットとなるチャネルを識別します。

これらのリソースにアクセスするには、有効なチャネル・トークンを提供する必要があります。 チャネル・トークンは、問合せパラメータとして指定することも、同じ名前のヘッダーとして指定することもできます。 リクエストに有効なchannelTokenが存在しない場合、リソースはHTTP 403 Forbidden: チャネル・トークンが正しくないか、リクエストに欠落しています。

アイテム・リソースをプレビュー(下記)では、クライアントがアプリケーションで使用できる様々な問合せおよび拡張機能を提供します。

プレビュー・リソースにアクセスするには:

  • リクエストにchannelToken値を渡します。

  • セキュア・チャネルでプレビュー・リソースにアクセスする前に認証を取得します。

チャネル・トークンを取得

チャネル・トークンを取得するには:

  1. OAuthを使用する前に、すでに認証されていることを確認します(「認可」を参照)。

  2. URLへのGETリクエストを実行する: 

    https://Content Management URL/content/management/api/v1.1/channels

    レスポンスのサンプル:

    JSONレスポンスには、各公開済チャネルのトークンが含まれます。 たとえば、ID RCHANNEL73166144CA54417294C002D4CC85FAAEを含むchannel1などです。 

    {
  "hasMore": false,
  "offset": 0,
  "count": 2,
  "limit": 2,
  "items": [
    {
      "id": "RCHANNEL73166144CA54417294C002D4CC85FAAE",
      "name": "channel1",
      "description": "",
      "createdBy": "User1",
      "createdDate": {
        "value": "2019-11-26T08:37:35.803Z",
        "timezone": "UTC"
      },
      "updatedBy": "User1",
      "updatedDate": {
        "value": "2019-11-26T08:37:35.803Z",
        "timezone": "UTC"
      },
      "isSiteChannel": false,
      "roleName": "manager",
      "links": [
        {
          "href": "http://myhost.us.example.com:7777/content/management/api/v1.1/channels/RCHANNEL73166144CA54417294C002D4CC85FAAE",
          "rel": "self",
          "method": "GET",
          "mediaType": "application/json"
        }
      ]
    },
    {
      "id": "RCHANNEL0E38831154DF4D848CED28979824F2D4",
      "name": "channel2",
      "description": "",
      "createdBy": "User1",
      "createdDate": {
        "value": "2019-11-26T08:54:58.129Z",
        "timezone": "UTC"
      },
      "updatedBy": "User1",
      "updatedDate": {
        "value": "2019-11-26T08:54:58.129Z",
        "timezone": "UTC"
      },
      "isSiteChannel": false,
      "roleName": "manager",
      "links": [
        {
          "href": "http://myhost.us.example.com:7777/content/management/api/v1.1/channels/RCHANNEL0E38831154DF4D848CED28979824F2D4",
          "rel": "self",
          "method": "GET",
          "mediaType": "application/json"
        }
      ]
    }
  ],
  "links": [
    {
      "href": "http://myhost.us.example.com:7777/content/management/api/v1.1/channels",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "http://myhost.us.example.com:7777/content/management/api/v1.1/channels",
      "rel": "canonical",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "http://myhost.us.example.com:7777/content/management/api/v1.1/metadata-catalog/channels",
      "rel": "describedby",
      "method": "GET",
      "mediaType": "application/schema+json"
    },
    {
      "href": "http://myhost.us.example.com:7777/content/management/api/v1.1/channels?offset=0",
      "rel": "first",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "http://myhost.us.example.com:7777/content/management/api/v1.1/channels?offset=0",
      "rel": "last",
      "method": "GET",
      "mediaType": "application/json"
    }
  ]
}
  3. URLへのGETリクエストを実行する: 
    https://Content Management URL/content/management/api/v1.1/channels/RCHANNEL73166144CA54417294C002D4CC85FAAE

    JSONレスポンスには、各公開済チャネルのトークンが含まれます。 たとえば、efe506cee46d451bb31d1c36e12e5b71は、channel 1 having ID RCHANNEL0E38831154DF4D848CED28979824F2D4のためのchannelTokenです。 

    {
  "id": "RCHANNEL0E38831154DF4D848CED28979824F2D4",
  "name": "Test10680223023446802",
  "description": "",
  "createdBy": "User1",
  "createdDate": {
    "value": "2019-11-26T08:54:58.129Z",
    "timezone": "UTC"
  },
  "updatedBy": "User1",
  "updatedDate": {
    "value": "2019-11-26T08:54:58.129Z",
    "timezone": "UTC"
  },
  "channelType": "public",
  "isSiteChannel": false,
  "publishPolicy": "anythingPublished",
  "localizationPolicy": "",
  "channelTokens": [
    {
      "name": "defaultToken",
      "token": "efe506cee46d451bb31d1c36e12e5b71",
      "expirationDate": {
        "value": "2099-01-01T12:00:00.000Z",
        "timezone": "UTC"
      }
    }
  ],
  "roleName": "manager",
  "links": [
    {
      "href": "http://myhost.us.example.com:7777/content/management/api/v1.1/channels/RCHANNEL0E38831154DF4D848CED28979824F2D4",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "http://myhost.us.example.com:7777/content/management/api/v1.1/channels/RCHANNEL0E38831154DF4D848CED28979824F2D4",
      "rel": "canonical",
      "method": "GET",
      "mediaType": "application/json"
    },
    {
      "href": "http://myhost.us.example.com:7777/content/management/api/v1.1/metadata-catalog/channels/RCHANNEL0E38831154DF4D848CED28979824F2D4",
      "rel": "describedby",
      "method": "GET",
      "mediaType": "application/schema+json"
    }
  ]
}

認証済の取得

セキュア・チャネルでプレビュー・リソースにアクセスする前に認証を取得するには:

メソッド1: 認可を参照してください。

メソッド2:
  1. チャネル・シークレットを生成するには、「チャネル・シークレットのRESTエンドポイント」を参照してください。
  2. チャネル・シークレットを使用してOAuthトークンを取得するには、「OAuthトークンの生成」を参照してください。