管理API

Version: 22.x

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

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

Admin APIは、XMテナントのExperience Edgeを管理できるようにするREST APIです。

ベースURL

Admin APIのベースURLはhttps://edge.sitecorecloud.io/api/admin/v1です。

認証

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

ヘッダー

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

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

存続時間

有効期限 (TTL) は、コンテンツとメディア項目がキャッシュに保持される最大時間を決定します。この期間は、その時間が経過する前に消去される可能性があります。コンテンツ(contentCacheTtl)とメディアアイテム(mediaCacheTtl)のTTL値は、複数のAdmin APIエンドポイントから返される応答パラメーターとして含まれます。両方のパラメータのデフォルト値はfour hoursです。

RequestResponse

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

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

RequestResponse

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

たとえば、"720.00:00:00" は値を720日に設定し、"00:15:00" は値を15分に設定します。

エンドポイント

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

ClearCacheForTenant - 特定のテナントのキャッシュ全体をクリアします。
DeleteContent - データストレージからテナントデータを削除します。
GetSettings - テナントで使用可能なすべての設定を一覧表示します。
UpdateSettings - テナントで使用可能なすべての設定を更新します。
PatchSettings - 1つ以上のパッチ操作を使用してテナントの設定を更新します。
CreateWebhook - 新しいWebhookを作成します。
UpdateWebhook - 既存のWebhookを更新します。
DeleteWebhook - 特定のWebhookを削除します。
ListWebhooks - テナントのすべてのWebhookが一覧表示されます。
GetWebhookById - 特定のテナントWebhookを取得します。

ClearCacheForTenantの

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

相対ルート	/cache
HTTP動詞	DELETE
応答形式	承認済みステータスコード (202)

コンテンツの削除

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

相対ルート	/content
HTTP動詞	DELETE
例	https://edge.sitecorecloud.io/api/admin/v1/content
応答形式	承認済みステータスコード (202)

GetSettings(ゲットセッティング)

テナントで使用可能なすべての設定を一覧表示します。

相対ルート	/settings
HTTP動詞	GET
例	https://edge.sitecorecloud.io/api/admin/v1/settings
応答形式	テナントの設定。 RequestResponse `{ "contentCacheTtl": "04:00:00", "contentCacheAutoClear": true, "mediaCacheTtl": "04:00:00", "mediaCacheAutoClear": true, "tenantCacheAutoClear": true }`

アップデート設定

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

相対ルート	/settings
HTTP動詞	PUT
例	https://edge.sitecorecloud.io/api/admin/v1/settings
ボディフォーマット	RequestResponse `{ "contentCacheTtl": "04:00:00", "contentCacheAutoClear": true, "mediaCacheTtl": "04:00:00", "mediaCacheAutoClear": true, "tenantCacheAutoClear": true }`
応答状態コード	受け入れられた (202)

パッチ設定

パッチ操作または複数のパッチ操作を使用して設定を更新します。 https://tools.ietf.org/html/rfc6902で指定されている操作とcontent-typeヘッダーにJSONパッチ形式を使用します。

相対ルート	/settings
HTTP動詞	PATCH
例	https://edge.sitecorecloud.io/api/admin/v1/settings
ヘッダー	コンテンツタイプ: application/json-patch+json
ボディフォーマット	設定操作。 replace操作のみが許可されます。詳細については、「 https://tools.ietf.org/html/rfc6902#section-4.3」を参照してください。次の例では、contentcachettl設定を15分に更新します。 RequestResponse `[ { "op":"replace", "path":"/contentcacheautoclear", "value":true }, { "op":"replace", "path":"/contentcachettl", "value":"00:15:00" } ]`
応答形式	テナントの設定。 RequestResponse `{ "contentCacheTtl": "00:15:00", "contentCacheAutoClear": true, "mediaCacheTtl": "04:00:00", "mediaCacheAutoClear": true, "tenantCacheAutoClear": true }`
応答状態コード	まあまあ (200)

Webhookの作成

新しいWebhookを作成します。

大事な

Webhookを作成するときは、HTTPではなくHTTPS URIを使用する必要があります。

相対ルート	/webhooks
HTTP動詞	POST
ボディフォーマット	Webhook構造。Edge Admin APIのWebhookエンドポイント内で使用されるさまざまなJSONオブジェクトの詳細については、Webhook objectsを参照してください。 RequestResponse `{ "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" }`
応答形式	Webhook構造。Edge Admin APIのWebhookエンドポイント内で使用されるさまざまなJSONオブジェクトの詳細については、Webhook objectsを参照してください。 RequestResponse `{ "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:04.6107312+00:00", "executionMode": "OnEnd" }`
レスポンスヘッダー	新しいWebhookの場所を返します。例えば：場所： https://edge.sitecorecloud.io/api/admin/v1/webhooks/12345
応答状態コード	創作日 (201)

アップデートウェブフック

既存のWebhookを更新します。

相対ルート	/webhooks/{id}
HTTP動詞	PUT
ボディフォーマット	Webhook構造。Edge Admin APIのWebhookエンドポイント内で使用されるさまざまなJSONオブジェクトの詳細については、Webhook objectsを参照してください。 RequestResponse `{ "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:04.6107312+00:00", "executionMode": "OnEnd" }`
応答状態コード	コンテンツなし (204)

削除Webhook

特定のWebhookを削除します。

相対ルート	/webhooks/{id}
HTTP動詞	DELETE
例	https://edge.sitecorecloud.io/api/admin/v1/webhooks/789
レスポンスステータス	コンテンツなし (204)

リストウェブフック

テナントのすべてのWebhookを一覧表示します。

相対ルート	/webhooks
HTTP動詞	GET
例	https://edge.sitecorecloud.io/api/admin/v1/webhooks
応答形式	Webhookの配列。Edge Admin APIのWebhookエンドポイント内で使用されるさまざまなJSONオブジェクトの詳細については、Webhook objectsを参照してください。 RequestResponse `[ { "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:04.6107312+00: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:04.6107312+00:00" "executionMode": "OnEnd" } ]`

GetWebhookById (英語)

特定のテナントWebhookをIDで取得します。

相対ルート	/webhooks/{id}
HTTP動詞	GET
例	https://edge.sitecorecloud.io/api/admin/v1/webhooks/789
応答形式	RequestResponse `{ "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:04.6107312+00:00" "executionMode": "OnEnd" }`

何かフィードバックはありますか?

この記事を改善するための提案がある場合は、