XM APIのエクスペリエンスエッジ

トークンAPI

Version:

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

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

Token APIは、DeliveryAPIへのアクセスに使用するAPIキーを管理できるREST APIです。これらのAPIキーは有効期間が長く、セッションベースのトークンではありません。キーを作成した後は、取り消すまで (APIへの追加の呼び出しを使用して) 引き続き使用できます。

ベースURL

Token API要求のベースURLは次のとおりです。https://edge.sitecorecloud.io/api/apikey/v1

認証

すべてのエンドポイントはベアラー認証を使用します。

ヘッダー

次のヘッダーが必要です。

名前	形式	目的
Authorization	Bearer {Token}	JSON Webトークン (JWT)。 OAuthを使用してExperience Edge XMのJWTをリクエストします。

エンドポイント

Token APIには、次のエンドポイントがあります。

Create - APIキーを生成します。
ListAll - テナント内のすべてのAPIキーを一覧表示します。
GetApiKeyByHash - ハッシュ値によって1つのAPIキーを取得します。
GetApiKeyByToken - トークンで識別される1つのAPIキーを取得します。
RenameByHash - ハッシュ値で識別されたAPIキーの名前を変更します。
RenameByToken - トークンによって識別されたAPIキーの名前を変更します。
RevokeByHash - ハッシュ値で識別されるAPIキーを取り消します。
RevokeByToken - トークンで識別されるAPIキーを取り消します。

創造する

キーを生成するときは、対象ユーザーとコンテンツスコープを定義する必要があります。Experience Edge for XMには、次のスコープが必要です。

audience-delivery - Delivery APIへのアクセスを承認します。
content-#everything# - すべてのコンテンツへのアクセスを許可します。

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

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

相対ルート	/
HTTP動詞	POST
体	DeliveryApiKeyInfoの構造は次のとおりです。 `{ "CreatedBy": "userName", "Label": "Example key", "Scopes": ["audience-delivery", "content-#everything#"] }`
応答	応答はトークン (Base 64文字列) です。例えば： MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3
例	次の例では、audience-deliveryのスコープを要求します。これは、返されたsc_apikeyがDelivery 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エンドポイントは、ハッシュ値によって1つの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エンドポイントは、トークンで識別される1つの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"
  }
]

RenameByHash

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

相対ルート

/renamebyhash/{hash}

HTTP動詞

PUT

ルートパラメーター

次のパラメータは必須です。

名前	形式	目的
hash	糸	名前を変更するキーのハッシュ。

体

本文要求には、次のフィールドが含まれている必要があります。

名前	形式	目的
newName	糸	APIキーの新しい名前。

応答形式

レスポンスは、キーの名前が正常に変更されたかどうかを示すブール値です。

RenameByToken (トークンによる改名)

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

相対ルート

/renamebytoken

HTTP動詞

PUT

ヘッダ

次のヘッダーが必要です。

名前	形式	目的
sc_apikey	糸	名前を変更するキーのトークン。

体

本文要求には、次のフィールドが含まれている必要があります。

名前	形式	目的
newName	糸	APIキーの新しい名前。

応答

レスポンスは、キーの名前が正常に変更されたかどうかを示すブール値です。

RevokeByHash

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

相対ルート

/revokebyhash/{hash}

HTTP動詞

PUT

ルートパラメーター

次のパラメータは必須です。

名前	形式	目的
hash	糸	取り消すキーのハッシュ。

応答

レスポンスは、キーが正常に取り消されたかどうかを示すブール値です。

RevokeByToken

RevokeByTokenエンドポイントは、トークンによって識別されるAPIキーを取り消します。

相対ルート

/revokebytoken

HTTP動詞

PUT

ヘッダ

次のヘッダーが必要です。

名前	形式	目的
sc_apikey	糸	取り消すキーのトークン。

応答

レスポンスは、キーが正常に取り消されたかどうかを示すブール値です。

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