トークンAPI

ヘッダー

名称

フォーマット

概要

Authorization

Bearer <YOUR_JWT>

必須。

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

例:

Bearer eyJhbG...

作成

APIキーを生成する際には、オーディエンスとコンテンツのスコープを定義する必要があります。Experience Edgeには以下のスコープが必要です:

• audience-delivery - デリバリー GraphQL APIへのアクセスを許可します。
• content-#everything# - すべてのコンテンツへのアクセスを許可する。

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

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

• 相対的なルート: /
• HTTP動詞: POST
• 本文
  。

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

• レスポンス
  、64の基数文字列です。例APIトークン
• 例
  。これは、返送された返sc_apikeyがデリバリー GraphQL APIに有効であることを意味します:

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

}

リストオール

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

• 相対的なルート: /
• HTTP動詞: GET
• クエリ文字列パラメータ:以下のパラメータが必要です
  返されるキーのスコープを定義します。提供されない場合は、すべてのキーを返します。利用可能なスコープは audience-delivery と content-#everything#です。labelString キーをフィルタリングするラベルまたはラベルの一部を定義します。この文字列を含むすべてのキーが返されます。提供されない場合は、すべてのキーが返されます。pagesize整数 ページあたり返されるキーの数を定義します。デフォルト
  。pagenumber整数 返すべきページ番号を定義します。デフォルト
  (最初のページを返します)。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
• ルートパラメータ:以下のパラメータが必要です
  。
• レスポンス:レスポンスはトークンに対応する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
• ヘッダー:以下のヘッダーが必要です
  _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

ルートパラメータ

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

NameFormat目的hash文字列 リ名前するキーのハッシュ。

本文

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

名前フォーマット目的newName文字列 APIキーの新しい名前。

応答形式

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

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

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

相対的な経路

/renamebytoken

HTTP動詞

PUT

ヘッダー

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

NameFormatPurposesc_apikey文字列 名前変更されるキーのトークン。

本文

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

名前フォーマット目的newName文字列 APIキーの新しい名前。

反応

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

リヴォークバイハッシュ

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

相対的な経路

/revokebyhash/{hash}

HTTP動詞

PUT

ルートパラメータ

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

NameFormat目的hash文字列 取り消すキーのハッシュ。

反応

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

RevokeByToken

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

相対的な経路

/revokebytoken

HTTP動詞

PUT

ヘッダー

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

NameFormatPurposesc_apikey文字列 キーのトークンを撤回する。

反応

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