ベース URL とリクエストの作成

このガイドでは、B2C Commerce API へのリクエストを適切な書式で作成する方法と、必要なすべてのパラメーターについて説明します。

B2C Commerce API へのすべてのリクエストのベース URL は、B2C Commerce インスタンスを識別し、リクエストを正しい API ファミリーに導くためのパターンに従っています。このパターンを理解するために、インスタンスと API ファミリーに応じて URL の部分にプレースホルダー (二重波括弧で囲まれている) を使用したベース URL を見ていきます。

次に、プレースホルダーを以下の値の例で置き換えます。

プレースホルダー	値
`{{shortCode}}`	`kv7kzm78`
`{{apiFamily}}`	`product`
`{{apiName}}`	`shopper-products`
`{{organizationId}}`	`f_ecom_zzte_053`

値の例を使ったベース URL は次のようになります。

この例では、ショートコードと組織 ID はデモ Sandbox (サンドボックス) のものです。自社の B2C Commerce インスタンスの値を確認する方法については、構成値ガイドを参照してください。

次に、ベース URL を getProduct エンドポイントと組み合わせて、RefArchGlobal サイトの商品 ID 25695327M の商品情報を取得しましょう。

エンドポイント名 getProduct は URL に含まれないことに注意してください。文字列 getProduct は、ドキュメント内でエンドポイントを識別するためにだけ使用されます。そのエンドポイントの URL は、products/{{productID}} をベース URL に追加することで作成できます。

このエンドポイントの例の完全な URL には、クエリ文字列に必要なクエリパラメーターである siteId も含まれます。

エンドポイントの多くには、必要なクエリパラメーターが含まれています。Shopper API の場合、siteId パラメーターがしばしば必要です。

有効なリクエストを行うには、適切に作成された URL だけでは不十分です。大部分のエンドポイントには、HTTP ヘッダーとリクエストボディのための追加の要件があります (通常は JSON オブジェクト)。API 参照資料を常に確認して、各エンドポイントの正確な要件を調べてください。

これで入門ガイドシリーズの最後のガイドを完了しました。

B2C Commerce API についてより詳細に学習するには、次のトピックを読むことをお勧めします。

他の Commerce API ユーザーから学ぶには、コミュニティガイドを参照してください。