1. OpenAPI

OpenAPI

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

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

OpenAPI 機能を使用すると、Sitecore Content Hub を Box、Gmail、Salesforce、Twitter などのサードパーティのサービスと統合することができます。

OpenAPI は、RESTful API の標準のインターフェイスを提供します。 その主なメリットは、最小限の実装ロジックでサードパーティのサービスとのインタラクションが可能なことです。

OpenAPI には、予測可能なリソース指向の URL があります。 OpenAPI は、JSON でエンコードされた応答を返し、HTTP の標準の応答コード、認証、動詞を使用します。

OpenAPI を使用すると、以下を含む API 全体を記述できます。

  • 使用可能なエンドポイント (例: /M.Asset) と各エンドポイントでの操作 (例: GET /M.Asset、POST /M.Asset)。
  • 操作パラメーターと各操作の入力と出力。
  • 認証方法。
  • 連絡先情報、ライセンス、使用条件、その他の情報。

詳細については、以下を参照してください。

[!警告] 現時点では、OpenAPI はプレビュー版の機能です。 すべての機能を有効にする場合は、Sitecore Content Hub™ アカウントマネージャーにお問い合わせください。

ドキュメント API

  • ドキュメント API は、Swagger UI などの OpenAPI ツールで読み取りおよび解釈できる標準の OpenAPI ドキュメントを提供します。

  • ドキュメント API では、Sitecore Content Hub™ で設定されたドメインでホストされるエンドポイント、操作、要求/応答スキーマ、HTTP スキーム、セキュリティ スキームを記述します。

  • ドキュメント API は、認可を必要としないパブリック リソースです。 これには、ドキュメント API とリソース ビュー API が含まれます。

  • エンドポイントのシグネチャは次のとおりです。

    /openapi/{openapi_version_integer}/{domain_identifier}/{optional:specification_version}

    以下に例を示します。

    https://stylelabs.com/openapi/v3/FruitfulContent

リソース ビュー API

  • リソース ビュー API は、ビジネス/外部の統合に必要な実際のデータを提供する API です。

  • リソース ビューは、ドメインの仕様を特定のエンティティに適用することによって取得されます。

  • リソース ビュー API は保護されたリソースであるため、承認が必要です。

  • エンドポイントのシグネチャは次のとおりです。

    /api/resourceViews/{domain_identifier}/{optional:specification_version}/{resourceView_identifier}/{entityId}

    以下に例を示します。

    https://stylelabs.com/api/resourceViews/FruitfulContent/FruitfulContentView/30652

この記事を改善するための提案がある場合は、 お知らせください!