1. Experience Edge API

トークンAPI

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

Token REST APIは、Delivery APIにアクセスする際に使用するAPIキーを管理できます。これらのAPIキーは長寿命であり、セッションベースのトークンではありません。キーを作成した後は、APIに追加の呼び出しを付けて、キーを取り消すまで使い続けられます。

ベースURL

こちらがToken REST APIの基本URLです:

https://edge.sitecorecloud.io/api/apikey/v1

認可

すべてのエンドポイントはベアラー認証を使用します。APIリクエストを認証するには:

ヘッダー

名称

フォーマット

概要

Authorization

Bearer {:placeholder-token:}<YOUR_JWT>{/:placeholder-token:}

必須。

あなたがAPIリクエストを承認するためにリクエストしたJSONウェブトークン(JWT)です。

例:

Bearer eyJhbG...

エンドポイント

Token REST APIには以下のエンドポイントがあります:

  • Create - APIキーを生成します。

  • ListAll - テナント内のAPIすべての鍵をリストアップします。

  • GetApiKeyByHash - 単一のAPIキーをハッシュ値で取得します。

  • GetApiKeyByToken - トークンで識別される単一のAPI鍵を取得します。

  • RenameByHash - ハッシュ値で識別されたAPIキーの名前を変更すること。

  • RenameByToken - トークンで識別されたAPI鍵の名前を変更すること。

  • RevokeByHash - ハッシュ値で識別されたAPIキーを取り消します。

  • RevokeByToken - トークンで識別されたAPIキーを取り消します。

作成

APIキーを生成する際には、オーディエンスとコンテンツの範囲を定義しなければなりません。Experience Edgeには以下のスコープが必要です:

  • audience-delivery - Delivery GraphQL APIへのアクセスを承認します。

  • content-#everything# - すべてのコンテンツへのアクセスを許可する。

追加のスコープやスコープタイプを作成することはできません。

CreateエンドポイントはAPIキーを生成します:

相対的な経路

/

HTTP動詞

POST

本文

DeliveryApiKeyInfoの構成は以下の通りです。

{
  "CreatedBy": "userName",
  "Label": "Example key",
  "Scopes": ["audience-delivery", "content-#everything#"]
}

反応

レスポンスはAPIトークンで、これは64ベースの文字列です。例APIトークン:

MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3

例

以下の例は のスコープを求めますaudience-delivery。つまり、返送されたsc_apikeyは納品GraphQL API有効であることを意味します:

    {
        "CreatedBy": "sitecore\sueb",
        "Label": "Testing Access",
        "Scopes": [
            "content-#everything#",
            "audience-delivery"
        ]
    }

リストオール

ListAllエンドポイントはテナント内のすべてのAPIキーを一覧にします:

相対的な経路

/

HTTP動詞

GET

クエリ文字列パラメータ

以下のパラメータが必要です:

名称

フォーマット

目的

scopes

文字列の配列

返却された鍵のスコープを定義します。提供されない場合は、すべての鍵が返却されます。

利用可能なスコープはaudience-deliveryとcontent-#everything#です。

label

ストリング

キーをフィルタリングするためのラベルまたはその一部を定義します。この文字列を含むすべての鍵は返されます。提供されない場合は、すべての鍵が返却されます。

pagesize

整数

ページあたり返されるキーの数を定義します。デフォルト:20。

pagenumber

整数

返すページ番号を定義します。デフォルト:1(最初のページを返す)。

filterRevoked

ブール

呼び出しがすべての鍵を返すのか、アクティブ鍵のみを返すのかを定義します。

パラメータを用いてクエリを行う際、以下の例構造を用いてください。

https://edge.sitecorecloud.io/api/apikey/v1?scopes=audience-delivery&label=mine&filterRevoked=true&pagesize=50&pagenumber=3

注記

scopesパラメータは列挙可能です。クエリ文字列内に複数回現れることもあります。

反応

レスポンスは、フィルタやページング設定、さらにページングメタデータを満たすDeliveryApiKeyの配列です。

{
  "totalCount": 2,
  "pageSize": 20,
  "currentPage": 1,
  "totalPages": 1,
  "hasNext": false,
  "hasPrevious": false,
  "keys": [
    {
      "TenantId": "Sitecore-tenant-id",
      "Hash": "1b84ed5b25f0eaa3a301fe72e89dc266362b999522a131d2de47744d7001cd07",
      "IsRevoked": false,
      "Label": "Example key",
      "Scopes": ["scope1", "scope2"],
      "CreatedBy": "ADN",
      "Created": "2020-12-02"
    },
    {
      "TenantId": "Sitecore-tenant-id",
      "Hash": "example_hash_2",
      "IsRevoked": false,
      "Label": "Example key 2",
      "Scopes": ["scope3", "scope4"],
      "CreatedBy": "ADN",
      "Created": "2020-12-02"
    }
  ]
}

GetApiKeyByHash

GetApiKeyByHashエンドポイントは、そのハッシュ値によって単一のAPIキーを取得します:

相対的な経路

/{hash}

HTTP動詞

GET

ルートパラメータ

以下のパラメータが必要です:

名称

フォーマット

目的

hash

ストリング

取得する鍵のハッシュ。

反応

応答はトークンに対応するDeliveryApiKeyです:

{
  "TenantId": "Sitecore-tenant-id",
  "Hash": "example_hash",
  "IsRevoked": false,
  "Label": "Example key",
  "Scopes": ["scope1", "scope2"],
  "CreatedBy": "ADN",
  "Created": "2020-12-02"
}

GetApiKeyByToken

GetApiKeyByTokenエンドポイントはトークンで識別される単一のAPI鍵を取得します。

相対的な経路

/token

HTTP動詞

GET

ヘッダー

以下のヘッダーが必要です:

名称

フォーマット

目的

sc_apikey

ストリング

回収すべき鍵のトークン。

反応

応答はトークンに対応するDeliveryApiKeyです:

[
  {
    "TenantId": "Sitecore-tenant-id",
    "Hash": "example_token",
    "IsRevoked": false,
    "Label": "Example key",
    "Scopes": ["scope1", "scope2"],
    "CreatedBy": "ADN",
    "Created": "2020-12-02"
  }
]

リネームByHash

RenameByHashエンドポイントは、ハッシュ値で識別されるAPIキーの名前を変更します:

相対的な経路

/renamebyhash/{hash}

HTTP動詞

PUT

ルートパラメータ

以下のパラメータが必要です:

名称

フォーマット

目的

hash

ストリング

リネームのためのキーのハッシュ。

本文

ボディリクエストには以下のフィールドが含まれなければなりません:

名称

フォーマット

目的

newName

ストリング

APIキーの新しい名前です。

応答形式

応答はキーが成功裏に名前変更されたかどうかを示すブール値です。

RenameByToken(リネーム・バイ・トークン)

RenameByTokenエンドポイントは、そのトークンで識別されるAPIキーの名前を変更します:

相対的な経路

/renamebytoken

HTTP動詞

PUT

ヘッダー

以下のヘッダーが必要です:

名称

フォーマット

目的

sc_apikey

ストリング

名前を変える鍵のトークン。

本文

ボディリクエストには以下のフィールドが含まれなければなりません:

名称

フォーマット

目的

newName

ストリング

APIキーの新しい名前です。

反応

応答はキーが成功裏に名前変更されたかどうかを示すブール値です。

リヴォークバイハッシュ

RevokeByHashエンドポイントは、そのハッシュ値で識別されたAPIキーを取り消します:

相対的な経路

/revokebyhash/{hash}

HTTP動詞

PUT

ルートパラメータ

以下のパラメータが必要です:

名称

フォーマット

目的

hash

ストリング

鍵を取り消すためのハッシュ。

反応

応答はキーが成功裏に取り消されたかどうかを示すブール値です。

RevokeByToken

RevokeByTokenエンドポイントはトークンで識別されたAPI鍵を取り消します。

相対的な経路

/revokebytoken

HTTP動詞

PUT

ヘッダー

以下のヘッダーが必要です:

名称

フォーマット

目的

sc_apikey

ストリング

取り消すための鍵の証。

反応

応答はキーが成功裏に取り消されたかどうかを示すブール値です。

この記事を改善するための提案がある場合は、 お知らせください!