--- title: "管理者API" slug: "admin-api" abstract: "Experience Edge環境を管理するための管理REST APIを説明します。" --- # 管理者API 管理者REST APIはExperience Edge環境の管理を可能にします。 ## ベースURL こちらが管理者REST APIの基本URLです: https://edge.sitecorecloud.io/api/admin/v1 ## 認可 すべてのエンドポイントはベアラー認証を使用します。APIリクエストを認証するには: 1. [環境用にEdge管理クライアントを作成します](https://doc.sitecore.com/xmc/en/developers/xm-cloud/en/manage-client-credentials-for-a-sitecoreai-organization-or-environment.html#UUID-920cbb42-c34a-43e9-d69a-fe81e3314424_section-idm1733356539496462)。これによりクライアントIDとクライアントシークレットが生成されます。 2. [クライアントIDとクライアントシークレットを使ってOAuthを使ってExperience Edge XM用のJWTを要求](https://doc.sitecore.com/xp/ja/developers/hd/19/sitecore-headless-development/request-a-jwt-for-experience-edge-xm-using-oauth.html "Request a JWT for Experience Edge XM using OAuth")Authorization ### ヘッダー 名称 フォーマット 概要 Authorization Bearer  必須。 APIリクエストを承認するためにリクエストしたJSONウェブトークン(JWT)です。 例: Bearer eyJhbG... ## 生きる時間 タイム・トゥ・ライブ(TTL)は、コンテンツやメディアアイテムがキャッシュ内に保持される最大時間を決定し、その期間が終了する前に削除される可能性があります。コンテンツ(contentCacheTtl)およびメディアアイテム(mediaCacheTtl)のTTL値は、複数の管理者APIエンドポイントによって応答パラメータとして含まれます。両方のパラメータのデフォルト値は*4時間*です。 { "contentCacheTtl": "\`04:00\`:00", "contentCacheAutoClear": true, "mediaCacheTtl": "\`04:00\`:00", "mediaCacheAutoClear": true, "tenantCacheAutoClear": true } TTL値を設定または更新するには、以下の表記法を持つ文字列を使用します。 {days}.{hours}:(minutes}:{seconds} 例えば、00:00:00""720.値は720日に設定され、00:15":00"は15分に設定されます。 ## エンドポイント 管理者REST APIには以下のエンドポイントがあります: - [ClearCacheForTenant](https://doc.sitecore.com/xp/ja/developers/hd/19/sitecore-headless-development/admin-api.html#UUID-d14f0bed-6692-4865-4e3f-589f23967400_N1623051021900 "ClearCacheForTenant") - 特定のテナントに対してキャッシュ全体をクリアします。 - [DeleteContent](https://doc.sitecore.com/xp/ja/developers/hd/19/sitecore-headless-development/admin-api.html#UUID-d14f0bed-6692-4865-4e3f-589f23967400_N1631784656638 "DeleteContent") - テナントデータをデータストレージから削除します。 - [GetSettings](https://doc.sitecore.com/xp/ja/developers/hd/19/sitecore-headless-development/admin-api.html#UUID-d14f0bed-6692-4865-4e3f-589f23967400_N1623051035733 "GetSettings") - テナントで利用可能なすべての設定を一覧にします。 - [UpdateSettings](https://doc.sitecore.com/xp/ja/developers/hd/19/sitecore-headless-development/admin-api.html#UUID-d14f0bed-6692-4865-4e3f-589f23967400_N1623051057764 "UpdateSettings") - テナントの利用可能なすべての設定を更新します。 - [PatchSettings](https://doc.sitecore.com/xp/ja/developers/hd/19/sitecore-headless-development/admin-api.html#UUID-d14f0bed-6692-4865-4e3f-589f23967400_N1623051099006 "PatchSettings") - 1つ以上のパッチ操作を使ってテナントの設定を更新します。 - [CreateWebhook](https://doc.sitecore.com/xp/ja/developers/hd/19/sitecore-headless-development/admin-api.html#UUID-d14f0bed-6692-4865-4e3f-589f23967400_N1623051069514 "CreateWebhook") - 新しいウェブフックを作成します。 - [UpdateWebhook](https://doc.sitecore.com/xp/ja/developers/hd/19/sitecore-headless-development/admin-api.html#UUID-d14f0bed-6692-4865-4e3f-589f23967400_N1623051143793 "UpdateWebhook") - 既存のウェブフックを更新します。 - [DeleteWebhook](https://doc.sitecore.com/xp/ja/developers/hd/19/sitecore-headless-development/admin-api.html#UUID-d14f0bed-6692-4865-4e3f-589f23967400_N1623051154703 "DeleteWebhook") - 特定のウェブフックを削除します。 - [ListWebhooks](https://doc.sitecore.com/xp/ja/developers/hd/19/sitecore-headless-development/admin-api.html#UUID-d14f0bed-6692-4865-4e3f-589f23967400_N1623051181456 "ListWebhooks") - テナントのすべてのウェブフックを一覧にします。 - [GetWebhookById](https://doc.sitecore.com/xp/ja/developers/hd/19/sitecore-headless-development/admin-api.html#UUID-d14f0bed-6692-4865-4e3f-589f23967400_N1623051166175 "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: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) ### パッチ設定 パッチ操作または複数パッチ操作で設定を更新します。操作およびコンテンツタイプヘッダーにはJSONパッチ形式を用い、[https://tools.ietf.org/html/rfc6902](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](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 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:04\`.6107312+\`00: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: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 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: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" }