Experience Edge API

管理者API

Version:

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

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

管理者REST APIはExperience Edge環境の管理を可能にします。

ベースURL

こちらが管理者REST APIの基本URLです:

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

認可

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

環境用にEdge管理クライアントを作成します。これによりクライアントIDとクライアントシークレットが生成されます。
クライアントIDとクライアントシークレットを使ってOAuthを使ってExperience Edge XM用のJWTを要求Authorization

ヘッダー

名称

フォーマット

概要

Authorization

Bearer <YOUR_JWT>

必須。

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

例:

Bearer eyJhbG...

生きる時間

タイム・トゥ・ライブ(TTL)は、コンテンツやメディアアイテムがキャッシュ内に保持される最大時間を決定し、その期間が終了する前に削除される可能性があります。コンテンツ(contentCacheTtl)およびメディアアイテム(mediaCacheTtl)のTTL値は、複数の管理者APIエンドポイントによって応答パラメータとして含まれます。両方のパラメータのデフォルト値は4時間です。

{ "contentCacheTtl": "`04

", "contentCacheAutoClear": true, "mediaCacheTtl": "`04

", "mediaCacheAutoClear": true, "tenantCacheAutoClear": true }

TTL値を設定または更新するには、以下の表記法を持つ文字列を使用します。

{days}.{hours}:(minutes}:{seconds}

例えば、00:00

""720.値は720日に設定され、00

"は15分に設定されます。

エンドポイント

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

ClearCacheForTenant - 特定のテナントに対してキャッシュ全体をクリアします。
DeleteContent - テナントデータをデータストレージから削除します。
GetSettings - テナントで利用可能なすべての設定を一覧にします。
UpdateSettings - テナントの利用可能なすべての設定を更新します。
PatchSettings - 1つ以上のパッチ操作を使ってテナントの設定を更新します。
CreateWebhook - 新しいウェブフックを作成します。
UpdateWebhook - 既存のウェブフックを更新します。
DeleteWebhook - 特定のウェブフックを削除します。
ListWebhooks - テナントのすべてのウェブフックを一覧にします。
GetWebhookById - 特定のテナントのウェブフックを受け取る。

クリアキャッシュフォーテナント

特定のテナントに対してキャッシュ全体をクリアします。

相対的な経路

/cache

HTTP動詞

DELETE

応答形式

承認済みステータスコード(202)

削除コンテンツ

テナントデータをデータストレージから削除します。

!警告危険この操作は即座にExperience Edgeのすべてのテナントデータを消去し、ライブの利用可能性にも影響を及ぼします。

相対的な経路

/content

HTTP動詞

DELETE

例

https://edge.sitecorecloud.io/api/admin/v1/content

応答形式

承認済みステータスコード(202)

GetSettings

テナントの利用可能なすべての設定を一覧にします。

相対的なルート: /settings
HTTP動詞: GET
例: https://edge.sitecorecloud.io/api/admin/v1/settings
レスポンス形式
。

{ "contentCacheTtl": "`04

", "contentCacheAutoClear": true, "mediaCacheTtl": "`04

", "mediaCacheAutoClear": true, "tenantCacheAutoClear": true }

アップデート設定

テナントの利用可能なすべての設定を更新します。

相対的なルート: /settings
HTTP動詞: PUT
例: https://edge.sitecorecloud.io/api/admin/v1/settings
ボディフォーマット:

{ "contentCacheTtl": "`04

", "contentCacheAutoClear": true, "mediaCacheTtl": "`04

", "mediaCacheAutoClear": true, "tenantCacheAutoClear": true }

応答ステータスコード
(202)

パッチ設定

パッチ操作または複数パッチ操作で設定を更新します。操作およびコンテンツタイプヘッダーにはJSONパッチ形式を用い、https://tools.ietf.org/html/rfc6902で指定されています。

相対的なルート: /settings
HTTP動詞: PATCH
例: https://edge.sitecorecloud.io/api/admin/v1/settings
ヘッダー:コンテンツタイプ: application/json-patch+json
本文形式
。置換操作のみが許可されています。詳細は https://tools.ietf.org/html/rfc6902#section-4.3 を参照してください。以下の例では、contentcachettlの設定を15分に更新します:

{ "op":"replace", "path":"/contentcacheautoclear", "value"

}, { "op":"replace", "path":"/contentcachettl", "value":"`00

" }

レスポンス形式
。

{ "contentCacheTtl": "`00

", "contentCacheAutoClear": true, "mediaCacheTtl": "`04

", "mediaCacheAutoClear": true, "tenantCacheAutoClear": true }

応答ステータスコード
(200)

CreateWebhook

新しいウェブフックを作成します。

!重要ウェブフックを作成する際はHTTPSではなくHTTPS URIを使う必要があります。

相対的なルート: /webhooks
HTTP動詞: POST
本文形式
。Edge Admin APIのwebhooksエンドポイント内で使用されているさまざまなJSONオブジェクトについては、Webhookオブジェクトを参照してください。

{ "label": "My new webhook", "uri": "https://www.mysite.com/hooks/edge-hook", "method": "POST", "headers": { "x-header": "bar" }, "body": "{\"rebuild\":\"true\"}", "createdBy": "anco", "executionMode": "OnEnd" }

レスポンス形式
。Edge Admin APIのウェブフックエンドポイント内で使用されているさまざまなJSONオブジェクトについては、Webhookオブジェクトを参照してください。

{ "id": "5678", "tenantId": "mysite-corp", "label": "webhook 29", "uri": "https://www.mysite.com/hooks/edge-hook", "method": "POST", "headers": { "x-header": "bar" }, "body": "{\"rebuild\":\"true\"}", "createdBy": "anco", "created": "2021-03-26T10:`44

`.6107312+`00

`", "executionMode": "OnEnd" }

Response header
。例:Location: https://edge.sitecorecloud.io/api/admin/v1/webhooks/12345
応答ステータスコード
(201)

更新ウェブフック

既存のウェブフックを更新します。

相対的なルート: /webhooks/{id}
HTTP動詞: PUT
本文形式
。Edge Admin APIのwebhooksエンドポイント内で使用されているさまざまなJSONオブジェクトについては、Webhookオブジェクトを参照してください。

{ "label": "webhook 29", "uri": "https://www.acme.com/hooks/edge-hook", "method": "GET", "headers": { "x-header": "bar" }, "body": "{\"rebuild\":\"true\"}", "createdBy": "anco", "created": "2021-03-26T10:`44

`.6107312+`00

`", "executionMode": "OnEnd" }

応答ステータスコード
(204)

DeleteWebhook

特定のウェブフックを削除します。

相対的な経路

/webhooks/{id}

HTTP動詞

DELETE

例

https://edge.sitecorecloud.io/api/admin/v1/webhooks/789

対応状況

コンテンツなし(204)

リストウェブフック

テナントのすべてのウェブフックをリストアップします。

相対的なルート: /webhooks
HTTP動詞: GET
例: https://edge.sitecorecloud.io/api/admin/v1/webhooks
レスポンス形式
。Edge Admin APIのWebhooksエンドポイント内で使用されているさまざまなJSONオブジェクトについては、Webhookオブジェクトを参照してください。

{ "id": "1234", "tenantId": "test-tenant", "label": "webhook 92", "uri": "https://localhost/", "method": "POST", "body": "This is my optional body content", "created": "2021-03-26T10:`44

`.6107312+`00

`" }, { "id": "5678", "tenantId": "test-tenant", "label": "webhook 29", "uri": "https://localhost/", "method": "POST", "headers": { "x-header": "bar" }, "createdBy": "anco", "created": "2021-03-26T10:`44

`.6107312+`00

`" "executionMode": "OnEnd" }

GetWebhookById

IDで特定のテナントのウェブフックを取得します。

相対的なルート: /webhooks/{id}
HTTP動詞: GET
例: https://edge.sitecorecloud.io/api/admin/v1/webhooks/789
回答形式:

{ "id": "1234", "tenantId": "test-tenant", "label": "webhook 92", "uri": "https://localhost/", "method": "POST", "headers": { "x-header": "foo" }, "body": "Optional body content", "createdBy": "adn", "created": "2021-03-26T10:`44

`.6107312+`00

`" "executionMode": "OnEnd" }

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