1. Experience Edge API

管理のREST API

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

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

管理者REST APIは 主に2つの機能を果たします

Edge設定管理とウェブフックです。

認可およびAPIアクセス

基本的なURLと認証については、認証およびAPIアクセスオプションをご覧ください。

タイム・トゥ・リブ(TTL)

生存時間(TTL)は、コンテンツやメディアアイテムがExperience Edgeキャッシュに保持される最大期間を決定します。コンテンツ(contentCacheTtl)およびメディア項目(mediaCacheTtl)のTTL値は、複数の管理者REST APIエンドポイントから返されるレスポンスパラメータとして含まれています。両方のパラメータのデフォルト値は4時間です。

{ "contentCacheTtl": "04:00

", "contentCacheAutoClear": true, "mediaCacheTtl": "04:00
", "mediaCacheAutoClear": true, "tenantCacheAutoClear": true }

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

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

例:

  • "720.00:00
    " 値を720日に設定します。
  • "00:15
    " 値を15分に設定します。

Experience Edge設定管理のためのエンドポイント

GetSettings

環境の利用可能なすべての設定を一覧にします。

{ "contentCacheTtl": "04:00

", "contentCacheAutoClear": true, "mediaCacheTtl": "04:00
", "mediaCacheAutoClear": true, "tenantCacheAutoClear": true }

アップデート設定

環境の利用可能なすべての設定を更新します。

{ "contentCacheTtl": "04:00

", "contentCacheAutoClear": true, "mediaCacheTtl": "04:00
", "mediaCacheAutoClear": true, "tenantCacheAutoClear": true }

  • 応答ステータスコード: Accepted (202)

パッチ設定

パッチ操作または複数パッチ操作で設定を更新します。このエンドポイントは、RFC 6902で指定された操作およびコンテンツ型ヘッダーに対してJSONパッチ形式を使用しています。

  • ルート: https://edge.sitecorecloud.io/api/admin/v1/settings
  • HTTP動詞: PATCH
  • ヘッダー: Content-Type: application/json-patch+json
  • 本文形式
    。交換操作のみが許可されています。詳細については、RFC 6902のセクション4.3を参照してください。以下の例では contentcachettl 設定を15分に更新します:

{ "op": "replace", "path": "/contentcacheautoclear", "value": true }, { "op": "replace", "path": "/contentcachettl", "value": "00:15

" }

  • レスポンス形式
    。

{ "contentCacheTtl": "00:15

", "contentCacheAutoClear": true, "mediaCacheTtl": "04:00
", "mediaCacheAutoClear": true, "tenantCacheAutoClear": true }

  • 応答ステータスコード: OK (200)

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

特定の環境に対してキャッシュ全体をクリアします。

削除コンテンツ

環境データがデータストレージから削除されます。

!警告危険この操作によりExperience Edgeのすべての環境データが即座に消去され、コンテンツのライブ利用にも影響が出ます。

ウェブフック管理用のエンドポイント

CreateWebhook

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

!重要ウェブフックを作成する際は、必ずHTTPS URIを使用しなければなりません。HTTPはサポートされていません。

  • ルート: https://edge.sitecorecloud.io/api/admin/v1/webhooks
  • HTTP動詞: POST
  • 本文形式
    。管理REST APIのウェブフックエンドポイント内で使用されるさまざまな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" }

  • レスポンス形式
    。管理REST 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" }

リストウェブフック

環境のすべてのウェブフックを一覧にします。

{ "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で特定の環境のウェブフックを取得します。

{ "id": "789", "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" }

更新ウェブフック

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

  • ルート: https://edge.sitecorecloud.io/api/admin/v1/webhooks/<WEBHOOK_ID>
  • HTTP動詞: PUT
  • 本文形式
    。管理REST APIのウェブフックエンドポイント内で使用されるさまざまな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" }

  • 応答ステータスコード: No content (204)

DeleteWebhook

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

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