1. Experience Edge for XM API

管理者API

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

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

Admin APIはREST APIで、XMテナント向けにExperience Edge for XMを管理できるようにします。

ベースURL

こちらがAdmin APIの基本URLです:

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

認可

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

ヘッダー

名称

フォーマット

概要

Authorization

Bearer {:placeholder-token:}<YOUR_JWT>{/:placeholder-token:}

必須。

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

例:

Bearer eyJhbG...

生きる時間

生存時間(TTL)は、コンテンツやメディアアイテムがキャッシュに保持される最大期間を決定し、その期間が切れる前に削除される可能性があります。コンテンツ(contentCacheTtl)とメディアアイテム(mediaCacheTtl)のTTL値は、複数の管理者APIエンドポイントから返される応答パラメータとして含まれています。両方のパラメータのデフォルト値はfour hoursです:

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

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

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

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

エンドポイント

Admin APIには以下のエンドポイントがあります:

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

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

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

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

  • PatchSettings - 1つ以上のパッチ操作を使ってテナントの設定を更新します。

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

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

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

  • ListWebhooks - テナントのすべてのウェブフックを一覧にします。

  • GetWebhookById - 特定のテナントのウェブフックを受け取る。

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

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

相対的な経路

/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

応答形式

テナントの設定。

{
    "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

ボディフォーマット

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

応答ステータスコード

アセプテンション(202年)

パッチ設定

パッチ操作または複数パッチ操作で設定を更新します。操作およびコンテンツタイプヘッダーには、https://tools.ietf.org/html/rfc6902で指定された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分に更新します:

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

応答形式

テナントの設定。

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

応答ステータスコード

OK(200)

CreateWebhook

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

大事な

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

相対的な経路

/webhooks

HTTP動詞

POST

ボディフォーマット

ウェブフック構造です。Edge管理者APIのwebhooksエンドポイント内で使用されているさまざまなJSONオブジェクトについて詳しく知りたい場合は、Webhook objectsを参照してください。

{
  "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管理者APIのwebhooksエンドポイント内で使用されているさまざまなJSONオブジェクトについて詳しく知りたい場合は、Webhook objectsを参照してください。

{
  "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"
}

レスポンスヘッダー

新しいウェブフックの位置を返します。例えば：

所在地: https://edge.sitecorecloud.io/api/admin/v1/webhooks/12345

応答ステータスコード

クリエイド(201年)

更新ウェブフック

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

相対的な経路

/webhooks/{id}

HTTP動詞

PUT

ボディフォーマット

ウェブフック構造です。Edge管理者APIのwebhooksエンドポイント内で使用されているさまざまなJSONオブジェクトについて詳しく知りたい場合は、Webhook objectsを参照してください。

{
  "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)

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管理者APIのwebhooksエンドポイント内で使用されているさまざまなJSONオブジェクトについて詳しく知りたい場合は、Webhook objectsを参照してください。

[
  {
      "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

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:04.6107312+00:00"
      "executionMode": "OnEnd"
  }
この記事を改善するための提案がある場合は、 お知らせください!