OCAPI メタデータ 23.1

Open Commerce API は、Open Commerce API 自体に関するデータ (メタデータ) を提供します。API メタデータは、所有 API である Meta API にアクセスして取得できます。この API は Shop API や Data API と同じようにアクセスできますが、API バージョンとしてバージョン 1 が必要です。Meta API は次の情報を提供します:

• 使用可能な API のリスト
• 使用可能な API バージョンのリスト
• リソースとその説明のリスト
• アクセス可能なドキュメントのリスト
• 1 つのドキュメントの説明

Meta API にアクセスするには、すべてのリクエストにおいて、Authorization: Bearer OAuth トークン を送信します。これは Account Manager で取得できます。アクセストークンの作成に使用したクライアント ID で、OCAPI 設定に基づいてすべてのリソースへのアクセスが確認され、使用可能なリソースとドキュメントのみが表示されます。メタデータへのアクセスに使用されるコンテキストに応じて、結果が異なる場合があります。特定サイトのコンテキストでは、当該サイトの OCAPI 設定は、リクエスト元のクライアントのアクセス権を確認するために使用されます。この場合、アクセスが許可されているリソースのみが表示されます。グローバルコンテキストでメタデータにアクセスする場合も、同じことが当てはまります。この場合は、グローバル OCAPI 設定は、クライアントがアクセス可能なメタデータのみを取得するために使用されます。

Meta API レスポンスは、ページキャッシュで 24 時間キャッシュされます。つまり、このメタデータのキャッシュはページキャッシュのクリアで自動的にクリアされます。

次の例は、使用可能な API のリストを示します:

次の例は、使用可能な API バージョンのリストを示します:

取得されたドキュメントは、Swagger のバージョン 2.0 とともに使用され、すべてのリソースパスと、その入力パラメーターおよび戻り値タイプの説明をリストします。次の例は、サポートされているリソース URI のリストを示します:

次の例は、特定バージョンの API の使用可能なドキュメントをすべて示します:

次の例は、リクエストされた特定バージョンの API ドキュメントのメタデータを示します:

また、クエリパラメーター children=embedded を追加して、下位ドキュメントの定義を含めることも可能です: