WooCommerce REST API: 統合、管理、トラブルシューティングガイド

Eコマースサイトは通常、高いコストと、定期的な在庫更新や注文処理など多くの手作業を伴います。しかし WooCommerce REST API 管理者がコードを使ってショップをより効率的に管理できるようになれば、こうした作業が軽減されます。

APIを使用することで、プロセスを自動化し、ショップを他のツールに接続し、手動で行うことなく日々のタスクを処理することができます。商品詳細の更新から注文の管理までREST API これは単純なHTTPリクエストで簡単にできます。

この記事ではWooCommerce REST APIとの統合また、テスト方法や製品管理に使用する方法、問題が発生した場合のトラブルシューティングの手順についても説明しています。

REST APIとは何ですか？

REST APIは、ソフトウェア・アプリケーションがインターネット上で相互に通信するための方法です。正式名称は 表現状態遷移(エクスプレッシブ・ステート・トランスファー）と呼ばれ、統合をシンプルかつスケーラブルにする一連の指針に従っています。

クライアントが REST API 経由でサーバーに情報を要求すると、サーバーは要求されたリソースの現在の状態を標準化された形式で返します。 クラッド(作成、読み取り、更新、削除）操作。

とともに ソープ などの他の技術と比較してREST 使用する帯域幅が少なく、インターネット環境に適しているため、より人気があります。

私たちは以前REST API記事の詳細についてはWooCommerce REST APIマニュアル：包括的な解説と実際のケーススタディ.

WooCommerceでREST APIを使用するメリット

WooCommerceでREST APIを使用することには、以下のような多くの利点があります：

• マルチプラットフォームの相互運用性をサポートREST APIは、複数のプラットフォーム間でシームレスな通信を可能にします。
• 開発の柔軟性を提供開発者は、必要に応じて柔軟にアプリケーションを構築できます。
• さまざまな機器との接続が可能REST APIを通じて様々なデバイスに簡単に接続できます。
• データ同期の簡素化REST APIを使えば、データの同期も簡単です。
• サードパーティコンテンツへの容易なアクセスサードパーティのコンテンツへの迅速な統合とアクセスのためにREST APIを使用してください。

WooCommerce REST APIを使用するための要件

WooCommerce REST APIを使用するには、以下の条件を満たしてください：

1. WooCommerce 3.5以上
2. WordPress 4.4以上
3. 固定リンクの有効化(パス: 設定 >) パーマリンク)
4. 安全なAPIアクセスのためにHTTPSを有効にします。(おすすめ）
5. PostmanまたはInsomniaでWooCommerce REST APIをテストします。

このチュートリアルでは、WooCommerceとWordPressの最新バージョンを使用します。WordPressの固定リンクが人間が読めるものであることを確認してください（Paths：設定 > 固定リンク).を選択します。記事タイトル"オプションがありますが、互換性を高めるために、"じゅんいつ「以外のフォーマット

ステップ

1. 出向く ダッシュボード → 設定 → 固定リンク.
2. 選択 "記事タイトル「をクリックしてください。変更の保存「ボタン

WooCommerce REST APIを統合するには？

APIとは、異なるソフトウェア・アプリケーションが相互に通信するためのツールです。例えば ペイパル このような決済ゲートウェイは、APIを通じてeコマースサイトに接続するため、決済機能を独自に構築する必要がなく、安全にトランザクションを処理します。

WooCommerce REST API は注文、商品、顧客を含むショップからのデータを読み書きします。例えば、オンラインショップのウェブサイトを運営している場合、商品が売り切れた時にAPIを使って在庫を自動的に更新することができます。

WooCommerce APIを使用して、以下の手順に従ってください：

ステップ1: WooCommerce APIのセットアップとアクセス

WooCommerce APIを使用するには、まずあなたのウェブサイトにWooCommerceをインストールする必要があります。ウェブサイトをお持ちでない場合は、チュートリアルを参照して作成してください：

初心者でもすぐに始められる：AliCloud + PagodaパネルでWordPressサイト構築完全攻略

1Panelを使ってTencent CloudにWordPressを手動でインストールするための超詳細な子守チュートリアル

WooCommerceサイトの準備ができたら、APIリクエストを認証するためにAPIキーを生成する必要があります。手順は以下の通りです：

• WooCommerceの設定ページに行き "上級" タブを選択し "REST API".

• ここでは、APIアクセスが必要なユーザーごとにキーを生成することができます。

次に APIエンドポイントWooCommerceは、注文、商品、顧客などの異なるタイプのデータにアクセスするための複数のエンドポイントを提供します。アクセスまたは変更したいデータに対応するエンドポイントを選択してください。

ここまでのステップを完了しました：WooCommerceがインストールされ、APIキーが生成され、ショップのデータにアクセスまたは変更するために正しいエンドポイントが選択されます。

ステップ 2: WooCommerceでAPIキーを作成します。

ステップ1では、WooCommerceをセットアップし、API環境を準備しました。ステップ2では、APIキーを生成する必要があります。APIキーは、注文の取得、商品の更新、顧客の管理など、ショップのデータに対するすべてのリクエストの認証に使用されるため、このステップは非常に重要です。

WooCommerceでAPIキーを作成する手順はとても簡単です：

• WordPressのダッシュボードにログインします。
• 出向く WooCommerce → 設定.

• クリック"上級"タブをクリックし"REST API"タブ

• クリックキーの追加/APIキーの作成ボタンをクリックして、新しいAPIキーを作成します。

ある 説明 フィールドにAPIキーの説明を入力します。

をとおして ユーザー ドロップダウンリストを使用して、このAPIキーに関連付けたいユーザーを選択します。使用したいユーザが表示されない場合は、最初に新しいユーザを作成する必要があります。

をとおして 管轄範囲 ドロップダウンリストを使用して、この API キーに付与する権限を選択します。以下の権限タイプを選択できます：

• 読み取り/書き込み許可（読み取り/書き込み）
• 読み取り専用パーミッション（読み取り専用）
• 書き込み専用パーミッション（書き込み専用）

• クリックAPIキーの生成ボタンをクリックしてAPIキーを生成します。

保証 消費者キー 歌で応える 消費者の秘密 値はコピーされ、安全な場所に保存されます。

これにより、WooCommerceショップにAPIキーが作成され、ショップのデータにプログラムでアクセスして操作できるようになります。

ステップ3: WooCommerceのREST APIが正しく動作することをテストします。

次に、REST API が正しく動作することをテストする必要があります。以下の手順に従って、REST API エンドポイントの機能を確認してください：

古いREST APIの有効化
最初のステップは古いREST APIを有効にすることです。 設定 → 詳細という新しいAPIをインストールする必要があります。しかし、現在は WooCommerce レガシー REST API の専用拡張プラグインです。

インストールが完了したら、古いAPIオプションをもう一度見てください。 "古いREST APIが有効" のチェックマークは

次のステップはAPIプラットフォームでのテストです。REST APIは2つのAPIテストベッドでテストされます：ポストマン歌で応える不眠症.

PostmanでのWooCommerce REST APIのテスト

ポストマン はAPIを構築・利用するためのプラットフォームです。PostmanでAPIをテストするには、まずアカウントを登録する必要があります。

テストするリクエストURLは wp-json/wc/v3/orders.私のサイトでは、完全なURLは似ています：
https://woocommerce-1146547-3986789.cloudwaysapps.com/wp-json/wc/v3/ordersあなた自身のURLに変更する必要があります。これを自分のウェブサイトのURLに変更する必要があります。

Postmanへのログインに成功したら、以下の手順でREST APIのテストを行います：

1. 新しいタブを開き WooCommerce REST API ドキュメント。
2. ブラウザの別のタブでポストマンを開きます。
3. WooCommerce REST API ドキュメントで 受注状況(注文）。
4. ドキュメントの右パネルからコードをコピーします。
5. 以下のスクリーンショットを参照してください。

このチュートリアルに従いやすくするために、コピーする必要があるコードを以下に示します：

curl -X POST https://example.com/wp-json/wc/v3/orders ˶ˆ꒳ˆ˵
    -u consumer_key:consumer_secret ୧-͈ᴗ-͈
    -H "Content-Type: application/json" ୧-͈ᴗ-͈
    -d '{
  "payment_method": "bacs"、
  "payment_method_title": "ダイレクト銀行振込"、
  "set_payment": true、
  "billing": {
    
    
    "address_1": "969 Market", "address_2": "
    "address_2": "", "city": "San Francisco".
    
    「state": "CA"、"postcode": "9410"。
    
    
    "email": "john.doe@example.com", "phone":"(555)
    "電話": "(555) 555-5555"
  }, "shipping": {{shipping}, "shipping": {{shipping}.
  "shipping": {
    「first_name": "John", "last_name": {
    
    "address_1": "969 Market", "address_2": "".
    
    
    州": "CA", "郵便番号": "9410".
    「郵便番号": "94103", "国": "US".
    国": "US".
  }, "line_items".
  "line_items": [
    {
      "product_id": 93, "quantity": 2
      「数量": 2
    }, { "line_items": [ "product_id": 93, "quantity": 2
    {
      "product_id": 22, "variation_id": 23, { { "product_id": 22, "variation_id": 23, "quantity": 2
      "variation_id": 23, "quantity": 1
      「数量": 1
    }
  ], "shipping_lines": [ "product_id": 22 "variation_id": 23 "quantity": 1 }.
  "shipping_lines": [
    {
      「method_id": "flat_rate", "method_title": "定額料金", "shipping_lines": [ { {
      
      "total": "10.00"
    }
  ]
}'

• コードをコピーするとポストマンタブ
• クリック"お気に入り"そしてインポート」をクリックします。.

• ペーストWooCommerce REST APIコピーした注文コードを記録し「コレクションにインポートボタン。

• オプションリクエストの種類によってゲット.

• コンパイラリクエストURL自分のサイトのURLを使用してください。

• 今すぐ選択認証タイプ.このため基本認証.
• 利用者ID歌で応える暗号化フィールドがあります。コンシューマーキー歌で応える消費者キー。記憶が正しければ、これはステップ 2 最後に保存されるもの最後に"送信"ボタン.

• WooCommerce ショップが正しくセットアップされ、REST API が有効化され、API キーが生成されると JSONレスポンスこれはショップの商品リストを含んでいます。レスポンスは次のようになります：

インソムニアのWooCommerce REST APIのテスト

REST API をテストするために使用される 2 番目のプラットフォームは次のとおりです。不眠症そのためには、まずシステムに Insomnia をインストールする必要があります。インストール後、以下の手順で REST API テストを実行します。

• クリック「新しいコレクション.

• コレクションクリステン.

• クリック「新しいHTTPリクエスト.

• オプションリクエストの種類によってゲット.

• コンパイラリクエストURLをクリックして、自分のサイトのURLを使用してください。

• オーソライズには基本認可。

• 利用者ID歌で応える暗号化フィールドが表示されます。コンシューマーキー歌で応える消費者キー

• 打点送信ボタンをクリックします。をクリックします。右のパネルで見るJSON形式その結果

このような応答が返ってきたら、おめでとうございます！REST APIは動作しています。
エラーが発生した場合は、API認証情報を再確認し、WooCommerceでREST APIが正しく有効になっていることを確認してください。

WooCommerce REST APIはどのように動作しますか？

WooCommerce REST APIはREST (Representational State Transfer)の原則に基づいており、標準のHTTPメソッドを使用して注文、商品、顧客などのショップデータとやり取りすることができます：

• ゲットデータの取得（注文リストの取得など）
• ポスト新規データの作成（新規商品の追加など）
• プット既存データの更新（変更注文のステータスなど）
• 削除データの削除（顧客の削除など）

各インタラクションはふりだし例えば、注文を取得するには、エンドポイント /wp-json/wc/v3/orders/{order_id}。.これらのエンドポイントはリソース構造に基づいており、各URLはシステム内の特定のタイプのデータを表しています。

つまり、クライアントからサーバーへの各リクエストには、サーバーがリクエストを完了するために必要なすべての情報が含まれていなければなりません。

データは通常 JSON 形式が交換されるため、ウェブアプリケーションでデータを簡単に扱うことができます。各 API リクエストは、通常 API キー (WooCommerce で生成可能) やその他のメソッド ( OAuth).

APIは、以下のようなさまざまなテストツールや統合ツールをサポートしています。 ポストマン 歌で応える 不眠症リクエストを送信し、応答を表示するのが簡単です。

ほとんどのユーザーにとって、外部サービスとの統合は非常に簡単で、通常はAPIキーを生成し、接続を確立するために外部サービスと共有するだけです。接続が成功すると、外部サービスは提供されたAPIを使用してWooCommerceショップと対話することができます。

REST APIによる商品管理（追加・編集・削除）の方法

前のセクションで、WooCommerce REST APIはPostmanとInsomniaを使ってテストされました。

WooCommerceの使用方法 製品オブジェクト ショップの商品を管理するためのものです。これらのオブジェクトは以下のような様々な属性を含んでいます。 価格(価格）、在庫状況(在庫状況）と グループ化された製品(商品のグループ化）。これらの属性により、管理者はAPIを通じて在庫、価格、商品分類などを簡単にコントロールすることができます。

例えば、製品をグループに割り当てるには、単にグループのIDを グループ化された製品 属性で十分です。

在庫管理には2つの重要な特徴があります：

1. 在庫管理に設定します。 真の もしかしたら 無実在庫管理を有効または無効にします。

2. 在庫状況製品の現在のステータスを反映するために使用されます：

• 在庫(在庫あり)
• オンバックオーダー(予約可）
• アウトストック(在庫なし）

次に、商品詳細をプログラムで追加・更新する方法を学びます。

WooCommerce API経由で商品を追加

Postmanを使ってショップに商品を追加するには、リクエストメソッドを ゲット 切り替える ポストに変更し、エンドポイントURLを
https://woocommerce-1146547-3986789.cloudwaysapps.com/wp-json/wc/v3/products

操作手順：

1. ポストマンのページへ ボディタブ.
2. オプション 生 オプションで書式を JSON.
3. 既存のコードを以下のJSONデータに置き換えてください：

{
  "name": "Macbook Pro M3"、
  "タイプ": "シンプル", "説明": "M3チップは8 CPUコア、10 GPUコア、16コアニューラルエンジンを搭載し、パフォーマンスを強化しました。
  "description": "M3チップは8CPUコア、10GPUコア、16コアニューラルエンジンを搭載し、パフォーマンスを強化"、
  "short_description": "", "description": "M3チップは8CPUコア、10GPUコア、16コアニューラルエンジンを搭載し、性能を強化しています。", "short_description": ""、
  
  "tags": []、
  画像": [], "画像": [], "画像": [], "画像
}

このJSONには商品の詳細が含まれています。名前、タイプ、説明とオプションのフィールドまるでカテゴリー, タグ歌で応える写真.

入力後 送信 ボタンをクリックします。商品の作成に成功すると、商品オブジェクトを含むレスポンスを受け取ります。

ショップに追加された商品です：

WooCommerce APIによる商品の編集

以前追加された商品に満足できず、編集したいとします - WooCommerce APIでも可能です。あなたが知る必要があるのは、以前ショップに追加された商品が 身分証明書.私の場合、製品は アイド で御座います 28.

このチュートリアルでは、以前に追加した製品の名前を変更します。手順は以下の通りです：

次のようにJSONデータを変更します：

{
  "name": "Macbook Air M3"
}

注：商品名を変更したいだけなので、他の属性は含めていません。また、新しい商品を追加する必要はなく、既存の商品を変更するだけなので、エンドポイントのURLを次のように変更します：

https://woocommerce-1146547-3986789.cloudwaysapps.com/wp-json/wc/v3/products<your-id-here>.

この例では、製品の 身分証明書 は28なので、URLは

https://woocommerce-1146547-3986789.cloudwaysapps.com/wp-json/wc/v3/products/28.

次に、リクエストメソッドを プットをクリックし、リクエストを実行します。ショップで更新された商品名を確認することで、更新が成功したことを確認できます。

これは、当ショップで更新された商品名です：

WooCommerce APIによる商品の削除

製品を取り除くには 削除 リクエスト方法ショップで以前に更新された内容を削除します。 Macbook Air M3 - 更新 製品手順は以下の通りです：

先ほどと同じエンドポイントURLを使いますが、リクエストタイプを 削除.

エンドポイントURLに商品のIDを入力し 送信.

商品は以下のようにショップから削除されます：

REST APIによる注文管理方法（注文ステータスの取得/更新）

WooCommerce REST APIは、注文ステータスの取得や更新などのタスクを自動化することで、注文処理を簡素化します。簡単にできます：

• 注文を取得し、日付、ステータス、または顧客によってそれらをフィルタリングします。
• 注文ステータスを更新し、異なるステージを反映させます。
• リクエストの処理や返金の自動化など、返金の管理。

次に、最新の注文を取得し、注文ステータスを「」に更新する方法をご覧ください。ダン".

ご注文

この例では、最新の注文を取り、そのステータスを"ダン".直近の注文を取得するには、日付範囲が必要です。 ゲット お願いします。

Postmanを使って最近の注文を取得する方法を紹介します：

1. まず、エンドポイントのURLを https:///wp-json/wc/v3/orders. URLは次のようになります：
   https://woocommerce-1146547-3986789.cloudwaysapps.com/wp-json/wc/v3/orders
2. 次に、最新の注文IDを取得する必要があるので、日付範囲を指定して 後に パラメータは今日以降の注文のみを取得します。私の例では、日付範囲は 2024-09-08t00:00:00何を言っているのかよくわかりません。私のURLはこんな感じです：
   https://woocommerce-1146547-3986789.cloudwaysapps.com/wp-json/wc/v3/orders?after=2024-09-08T00:00:00

URLを変更したら Paramsタブで、Value 日付は以下のようにフィールドに追加されます：

リクエストを実行すると、指定された日付条件に一致するショップからの最近の注文のリストを見ることができます。

私の場合、注文IDは 「id": 25州は 「保留中.に変更しました。 完成いいですか？

注文状況の更新

注文状況を更新するには プット リクエスト・メソッド。この例では、注文IDは25なので、URLは次のようになります：

https://woocommerce-1146547-3986789.cloudwaysapps.com/wp-json/wc/v3/orders/25

次に ボディ タブを開き、以下のJSONデータを追加します：

{
  "ステータス": "完了"
}

このリクエストを実行すると、注文ステータスが次のように更新されます。 ダン以下のように：

REST APIによるクライアント管理方法（クライアントIDの追加/取得）

WooCommerce REST APIを使用することで、顧客管理とインタラクションがより簡単になります。

ビジネスには

• 顧客プロファイルの作成と更新
• 購入履歴や嗜好設定などの顧客情報を取得します。
• このデータは、パーソナライズされたマーケティング、ターゲットを絞ったプロモーションの送信、製品の推奨に使用します。

これにより、企業は顧客との関係を深め、リピート購入を促進することができます。

クライアントの追加

クライアントを追加するには ポスト リクエスト・メソッドを使用し、エンドポイント URL を次のように変更します：
https://woocommerce-1146547-3986789.cloudwaysapps.com/wp-json/wc/v3/customers

次に ボディ タブで、以下のJSONを使用して新しい顧客を作成します：

{
  "email": "a.rehman@gmail.com"、
  「first_name": "Abdul"、
  
  
  
  "billing": {
    「first_name": "Abdul", "last_name": "Rehman", "billing": {
    "last_name": "Rehman", "company": "", "company": "abdul.rehman", "customer".
    "company": "", "address_1": "123".
    「address_1": "123 Main Street", "address_2": "", "address_2": "123 Main Street".
    「address_2": ""、"city": "Lahore".
    「city": "Lahore", "state": "Punjab".
    州": "パンジャブ", "郵便番号": "54000".
    「郵便番号": "54000
    
    
    "電話": "(555) 555-5555"
  }, "shipping".
  "shipping": {
    "first_name": "Abdul", "last_name": {
    「last_name": "Rehman", "company": ", "company": "(555)
    "company": "", "address_1": "123".
    「address_1": "123 Main Street", "address_2": "、
    「address_2": ""、"city": "Lahore".
    「city": "Lahore", "state": "Punjab".
    州": "パンジャブ", "郵便番号": "54000".
    「郵便番号": "54000
    国": "PK"
  }
}

リクエストを実行すると、顧客の詳細が記載された返信が届きます。必ず顧客IDこれは、次のセクションでその顧客の詳細を取得するために必要だからです。

ご覧のように、新しい顧客情報は、顧客IDが「id": 2.

IDによる顧客情報の取得

では ゲット リクエストメソッドを使用して、以前に作成した顧客IDに基づいて顧客情報を取得します。私の例では、顧客IDは "2".

エンドポイントURLに以下の形式でクライアントIDを追加します：
https:///wp-json/wc/v3/customers/。

私のエンドポイントURLは以下の通りです：
https://woocommerce-1146547-3986789.cloudwaysapps.com/wp-json/wc/v3/customers/2

リクエストを実行すると、以下のようにこの顧客の詳細が表示されます：

WooCommerce REST API 利用可能なエンドポイント

WooCommerce REST APIはエンドポイントを通してショップの様々な部分へのアクセスを提供します。エンドポイントはショップの様々な機能を実行する特定のURLです。 /wp-json/wc/v3/products ショップの商品を取得、作成、更新できるエンドポイント。

以下に、主要なエンドポイントのリストと、それに対応する PHP のコード例を示します：

概要

全体的に、WooCommerce REST APIはオンラインビジネスを強化したいユーザーにとって素晴らしいツールです。ショップを他のアプリケーションに接続し、ワークフローを自動化することで、プロセスを最適化し、時間と労力を節約することができます。