OCAPI 23.2: はじめに

Open Commerce API (OCAPI) によって、HTTP リクエストと HTTP レスポンスを使用してリソースにアクセスできます。各リソースは一意の URL でアドレス指定されており、URL には API バージョンが含まれています。データは、リクエストパラメーターまたはヘッダーパラメーターを使用して、あるいは定義された構造をもつ JSON ドキュメントとしてリクエストボディ内で転送されます。OCAPI は複数の API に分類されます。Shop API では、クライアントは店舗顧客として、または顧客の代わりに買い物を行うエージェントとして、システムと対話します。Data API は、システムリソースへのアクセスの作成/読み取り/更新/削除を行うために使用します。そして、Meta API は、カスタム属性を含む Open Commerce API の形式的記述を取得するために使用します。API の使用を開始する前に、次のステップを実行することをお勧めします:

3 つの API は以下の目的で使用します:

  • Shop API を使用して、商品とカタログのデータ、画像、推奨項目、および価格またはプロモーションなどの公開されている店舗情報にアクセスします。Shop API を使用する場合は、ゲスト顧客のコンテキストでシステムと対話する場合がほとんどなため、認証は必要ありません。しかし、他のすべてのリクエストと同様に、システムは Open Commerce API 設定をチェックして、指定されたリソースの使用が、提供されたクライアント ID に許可されているかどうかを検証します。
  • 店舗顧客としてシステムと対話するには、登録済み顧客またはゲスト顧客のコンテキストで Shop API を使用します。たとえば、顧客固有のデータにアクセスする場合や、買い物カゴを作成して送信する場合などです。各リクエストで渡される JWT を取得することによって、顧客を認証します。
  • 店舗顧客の代わりにエージェントとしてシステムと対話するには、Business Manager ユーザーのコンテキストで Shop API を使用します。たとえば、顧客固有のデータにアクセスする場合や、買い物カゴを作成して送信する場合などです。各リクエストで渡される Business Manager ユーザーの OAuth トークンを取得することによって、ユーザーを認証します。システムはリクエストを許可する前に、Open Commerce API 設定 と必要な Business Manager 許可の両方をチェックします。
  • Data API を使用して、クーポン、顧客リスト、スロット設定、コンテンツなどのマーチャントのリソースへのアクセスまたは更新を行います。各リクエストで渡されるクライアント ID または Business Manager ユーザーの OAuth トークンを取得することによって、リクエストを認証します。
  • Meta API を使用して、Open Commerce API によって提供されるリソースおよびドキュメントについての詳細にアクセスします。

追加の学習資料については、以下を参照してください。