--- title: "管理のREST API" slug: "admin-rest-api" abstract: "API管理者のREST APIの参考資料で、Experience Edge設定やウェブフックの管理に使われます。" --- # 管理のREST API 管理者REST APIは [主に2つの機能を](https://doc.sitecore.com/sai/ja/developers/sitecoreai/experience-edge/experience-edge-apis.html "Experience Edge APIs")果たします:Experience Edge設定管理とウェブフックです。 ## 認可およびAPIアクセス 基本的なURLと認証については、[認証およびAPIアクセスオプション](https://doc.sitecore.com/sai/ja/developers/sitecoreai/experience-edge/experience-edge-apis/authorization-and-api-access.html "Authorization and API access")をご覧ください。 ## タイム・トゥ・リブ(TTL) 生存時間(TTL)は、コンテンツやメディアアイテムがExperience Edgeキャッシュに保持される最大期間を決定します。コンテンツ(contentCacheTtl)およびメディア項目(mediaCacheTtl)のTTL値は、複数の管理者REST APIエンドポイントから返されるレスポンスパラメータとして含まれています。両方のパラメータのデフォルト値は4時間です。 { "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分に設定します。 ## Experience Edge設定管理のためのエンドポイント ### GetSettings 環境の利用可能なすべての設定を一覧にします。 - ルート: https://edge.sitecorecloud.io/api/admin/v1/settings - HTTP動詞: GET - レスポンス形式:環境設定。 { "contentCacheTtl": "04:00:00", "contentCacheAutoClear": true, "mediaCacheTtl": "04:00:00", "mediaCacheAutoClear": true, "tenantCacheAutoClear": true } ### アップデート設定 環境の利用可能なすべての設定を更新します。 - ルート: https://edge.sitecorecloud.io/api/admin/v1/settings - HTTP動詞: PUT - ボディフォーマット: { "contentCacheTtl": "04:00:00", "contentCacheAutoClear": true, "mediaCacheTtl": "04:00: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:00" } - レスポンス形式:環境設定。 { "contentCacheTtl": "00:15:00", "contentCacheAutoClear": true, "mediaCacheTtl": "04:00:00", "mediaCacheAutoClear": true, "tenantCacheAutoClear": true } - 応答ステータスコード: OK (200) ### クリアキャッシュフォーテナント 特定の環境に対してキャッシュ全体をクリアします。 - ルート: https://edge.sitecorecloud.io/api/admin/v1/cache - HTTP動詞: DELETE - 回答形式: Accepted status code (202) ### 削除コンテンツ 環境データがデータストレージから削除されます。 > !警告**危険**この操作によりExperience Edgeのすべての環境データが即座に消去され、コンテンツのライブ利用にも影響が出ます。 - ルート: https://edge.sitecorecloud.io/api/admin/v1/content - HTTP動詞: DELETE - 回答形式: Accepted status code (202) ## ウェブフック管理用のエンドポイント ### 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:04.6107312+00:00", "executionMode": "OnEnd" } - Response header: 新しいウェブフックの位置を返します。例の場所: https://edge.sitecorecloud.io/api/admin/v1/webhooks/12345 - 応答ステータスコード: Created (201) ### リストウェブフック 環境のすべてのウェブフックを一覧にします。 - ルート: https://edge.sitecorecloud.io/api/admin/v1/webhooks - HTTP動詞: GET - 例: https://edge.sitecorecloud.io/api/admin/v1/webhooks - レスポンス形式:多数のウェブフック。管理REST APIのウェブフックエンドポイント内で使用されるさまざまな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で特定の環境のウェブフックを取得します。 - ルート: https://edge.sitecorecloud.io/api/admin/v1/webhooks/ - HTTP動詞: GET - 例: https://edge.sitecorecloud.io/api/admin/v1/webhooks/789 - 回答形式: { "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:04.6107312+00:00", "executionMode": "OnEnd" } ### 更新ウェブフック 既存のウェブフックを更新します。 - ルート: https://edge.sitecorecloud.io/api/admin/v1/webhooks/ - 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:04.6107312+00:00", "executionMode": "OnEnd" } - 応答ステータスコード: No content (204) ### DeleteWebhook 特定のウェブフックを削除します。 - ルート: https://edge.sitecorecloud.io/api/admin/v1/webhooks/ - HTTP動詞: DELETE - 例: https://edge.sitecorecloud.io/api/admin/v1/webhooks/1234 - 応答状況: No content (204)