REST API

このREST APIはHTTPの上に構築されたハイパーメディアAPIです。Sitecore Content Hub内のすべてのオブジェクトは、リクエスト時のオブジェクトの状態を表すリソースとしてモデル化されています。標準的なHTTPリクエストとレスポンスはオブジェクトの状態を照会・操作するために使用され、標準的なHTTPヘッダーはリクエストとレスポンスを補強します。さらに、すべてのサービスで一貫したパフォーマンスを提供するために、バックエンドサービスはスロットリング機構を適用します。

RESTアーキテクチャパターンは、システムの状態をリソースとしてモデル化します。各リソースは一意のURLで識別されます。HTTPリクエストを実行することで、リソースの表現を転送・操作することができます。このREST APIが異なるのは、ハイパーメディアAPIであることです。本質的には、ハイパーリンクはリソース間のナビゲーションに使われ、特定のリソースへのURLがどのように構築されているかの知識を必要とします。実際、このREST APIドキュメントで指定されたURL(サービスエンドポイントを除く)はドキュメント目的のみであり、クライアントが直接使用すべきではありません。代わりに、クライアントはナビゲーションモデルを採用し、リソース間をナビゲートしてURLを発見すべきです。

!注最適なパフォーマンスを確保するために、以下のデフォルトタイムアウト値は接続やリクエストを開いたままにできる期間を定義しています。これらはすべてのREST APIに適用されます:

• API keep-alive timeout - 60秒

• API timeout - 140秒

APIアクセスはHTTPS経由で、

https://{<YOUR_SERVER>}/api/

!注すべてのデータはJSONで送受信されます。

Content Hubリソースに対してCRUD操作を行うために、以下のREST APIを使用できます:

• 監査API - 監査ログの取得とクエリ。
• キャッシュAPI - キャッシュをクリアするためのものです。
• ダウンロード注文API - ダウンロード注文の作成と取得。
• エンティティAPI - エンティティと連携するためのものです。
• エンティティ定義API - エンティティ定義を管理するためのものです。
• ジョブAPI - ジョブターゲットや記述の取得、作成、更新、削除。
• クエリAPI - 特定の条件に合致するエンティティを取得するためのものです。
• Search API - 検索クエリの実行、ファセット値の取得、検索フィルターの削除、またはファセットクエリの取得。
• Selection API - 選択プール間のエンティティ選択を管理するためのものです。
• Status API - システムの健康状態を監視するためのものです。
• アップロードAPI - Content Hubにアセットをアップロードするためのものです。

!注スロットリングに関するガイドラインはドキュメントの ベストプラクティス セクションにあります。REST APIは内部でスロットリングを扱 っておらず 、開発者はコード内で対応する必要があります。ベストプラクティスには、いつScriptsを使うべきか、いつMicrosoft Azure機能を使うべきかの詳細も記載されています(特に「統合ツールの選択方法」を参照してください)。