WooCommerceAPIの簡単なガイド

公開: 2020-12-28

WordPressによって、他のほとんどのプラットフォームよりもWebサイトの公開プロセス全体が簡単かつシンプルになったことは間違いありません。 証拠として、WordPressコアの使用に関する驚くべき統計を簡単に見ることができます。 さらに、WooCommerceは、WordPressがWebパブリッシングに対して行っているのと同じことをeコマースに対して行っています。 初心者向けであることに加えて、サイトを最適化するためのWooCommerceAPIなどの開発者向けのツールを提供します。

この記事では、WooCommerce REST APIを紹介し、それがWordPress独自のAPIとどのように関連しているかについて説明します。 また、この強力な技術を使用する理由と、開始方法についても説明します。

さっそく飛び込もう！

WooCommerce RESTAPIの紹介

WooCommerce APIを使用すると、ソフトウェアレベルでサイトのカスタム機能を実装できます。 WooCommerceと統合するように特別に設計された方法でコーディングできます。 そのため、時間、スキル、および（潜在的に）予算があれば、実質的にすべての機能を作成できます。

この重要な機能がどのように機能するかを理解するには、次の2つの用語を理解する必要があります。

  • Representational State Transfer（REST）。 これは複雑なトピックですが、この記事の目的上、RESTはWebページの特定の要素にアクセスできる「Webサービス」の一種です。
  • アプリケーションプログラミングインターフェイス（API）。 グラフィカルユーザーインターフェイス（GUI）とは対照的に、これは基本的に、アクセスポイントを操作できるようにするコードフックとフィルターのセットです。 通常、それらを特定のWordPressベースのファイルにコーディングします。

言い換えると、RESTはコードを介してサイトでアクセスできるものを定義し、APIはそのアクセスを活用するためのツールを提供します。 一緒に、それらはあなたがあなたのサイトがどのように機能するかについて重要な変更を加えることを可能にします。

WooCommerceAPIとWordPressRESTAPIの関係

それが最初に導入されたとき、WooCommerceAPIは単一のエンティティでした。 言い換えれば、WooCommerceの「エンドポイント」にアクセスするためだけに設計されており、WordPressの他の要素には影響しませんでした。

ただし、WordPress REST APIが導入されると、WooCommerceのエンドポイントがマージされ、内部でWordPressにアクセスするための1つの包括的な「go-to」が作成されました。 それでも、WooCommerceAPIのドキュメントはまだあります。 そのドキュメントの紹介を読んだ場合、APIの歴史は大まかに概説されています。

この記事では、「WooCommerce API」を、そのeコマースプラットフォームの特定のエンドポイントのコレクションと見なします。 もちろん、コアエンドポイントも役立つので、それらのいくつかについても説明します。 つまり、これら2つのAPIを分離しようとすることに夢中にならないようにするのが最善です。現在、これらは1つで同じです。

WooCommerceAPIを使用する理由

WooCommerce REST APIが、ストアの矢筒の中でエキサイティングで強力な矢印である理由は、すでにおわかりかもしれません。 使用を検討する理由のほんの一部を次に示します。

  • 実装するカスタム機能があります。 プラグイン、テーマ、または追加のコードスニペットで必要なものが見つからない場合は、自分で機能を作成することもできます。
  • 顧客はカスタムフロントエンドを入手できます。 WordPress REST APIの幅広い機能を使用して、サイトのフロントエンドをバックエンドから切り離すことができます。 これにより、別の言語を使用してページレイアウトやデザインを作成しながら、内部でWordPressのパワーを活用できます。
  • チームはカスタムバックエンドを使用できます。 顧客が独自のフロントエンドエクスペリエンスを利用できるように、WooCommerceのさまざまな部分を利用して、カスタムのバックエンドダッシュボードを作成できます。 必要なほぼすべてのメトリックまたはデータを含めることができ、基本的に独自のユーザーインターフェイスと分析プラットフォームを作成します。

理由が何であれ、WooCommerceAPIはいくつかの非常に強力な機能を提供します。 それをさらに実証するために、このAPIの詳細のいくつかを見て、サイトのどこでどのように使用できるかを見てみましょう。

WooCommerce APIを使用して達成できること（4つの例）

WooCommerce APIに関しては、「すべてが可能です」と単純に言いたくなります。 ただし、発生する可能性のあるいくつかの一般的なタスクと、いくつかの特定の使用例を確認する価値があります。

1.製品の作成、更新、および削除

あなたの店の製品はあなたのビジネスの生命線であるため、WooCommerce APIは、それらすべてを確実に管理できるようにするための多くのオプションを提供します。 一部のエンドポイントは読み取り専用ですが、WooCommerce内で収集された実質的にすべての情報を操作できます。 単一の製品、バリエーション、属性とその用語、分類法、出荷クラス、およびレビュー用に個別のAPIもあります。

これが役立つ方法はたくさんあります。 たとえば、ユーザーが自分の製品をアップロードするマーケットプレイスサイトについて考えてみます。 フロントエンドアップローダーを作成して、ユーザー入力に基づいて必要な管理タスクを実行できるようにすることができます。 また、ユーザーのリクエストに基づいて関連する多くの商品レビューをバッチ編集したり、識別用のメールを削除したりすることもできます。

2.プロセスオーダーとそれに関連する注記

製品があなたの店の生命線であるならば、注文はロケット燃料です。 そのため、WooCommerce APIは、注文やメモの管理に役立つ多くの機能を提供します。 WooCommerce内にある実質的にすべてのプロパティに、関連する請求、配送、メタデータのプロパティとともにアクセスできます。

このエンドポイントの用途の大部分は、何らかの方法で注文を一覧表示することであると私たちは主張します。 単純な1行のスニペットでさえ、非常に強力です。 たとえば、リストを解析して同じ製品の複数の言及を調べたり、マルチバスケットに特定のアイテムが含まれている注文について集計したりすることができます。

注文メモのバッチ更新は、APIのこの側面のもう1つの便利な使用法です。 クリスマスの注文のコレクションを取得し、それぞれのステータスに基づいて分割し、結果のJSONをスプレッドシートに整理すると、注文をより迅速かつ効率的に配信するのに役立ちます。

3.税率とクラスを調整します

多くの店主にとって、特に国際的な注文を扱っている場合、税金は頭痛の種です。 さまざまなレートで税金を適用するさまざまな方法があるため、WooCommerceAPIはこのデータを操作するための複数のオプションを提供します。 エンドポイントは、次の2つのバリエーションに分類されます。

  • 税率：これは、他のいくつかの識別データとともに、実際のパーセンテージが記録される場所です。
  • 税クラス：これらは、税率が適用される幅広い税です。

たとえば、「標準税率」クラスに適用される20％の税率を作成できます。 実際、税率をバッチ更新できることは、WooCommerceAPIの優れた使用法です。 よりユニークな例は、特定の顧客属性に基づいて税率またはクラスが作成される設定です。 これは、顧客を登録したり、チェックアウトプロセスに送信したりする前に、顧客を「認定」する必要がある状況に最適です。

4.配送ゾーン、場所、および方法を設定します

WooCommerceで配送を試したことがある場合は、それがどのような地雷原であるかを理解できます。 要素を間違えると、フィードバックやレビューが不十分な領域で顧客に直接影響が及びます。 幸い、WooCommerce APIは、ゾーン、場所、メソッドなど、配送に関連するすべてのエンドポイントと連携できます。

APIの他の側面と比較すると、ここで使用できる属性はそれほど多くありません。 ただし、ストアのデータを操作するのに役立つオプションはまだたくさんあります。 出荷情報を「設定して忘れる」ことがよくありますが（その複雑さとユーザーエクスペリエンスへの影響を考えると）、まだいくつかの実用的なアプリケーションがあります。

たとえば、州全体と国全体の両方で、現在のCOVID-19規制に注意する必要があります。 これを念頭に置いて、エンドポイントの組み合わせを使用して、一時的に特定の場所への配送を制限することを検討してください。 さらに、購入時に遅延が発生した場合はユーザーに通知することができます。 これは、チェックアウト画面で、またはマスコミを通じて発生する可能性があります。

WooCommerceAPIの使用を開始する方法

WooCommerce REST APIは、アクセスとアクセス許可を付与するためのデジタルキーベースのシステムを介して機能します。 この認証プロセスには、2つの異なるステップがあります。

  • WooCommerceは、コンシューマーキーとシークレットキーの2つのキーを作成します。 それらはランダムな文字列から作られ、クラックすることは事実上不可能です。
  • REST APIを「呼び出す」場合は常に、認証の証明としてこれらのキーを提供する必要があります。

このプロセスは簡単ですが、これらのキーを取得する（およびAPI自体を使用する）には、WooCommerceダッシュボード（特にWooCommerce>設定>詳細画面）に移動する必要があります。 上部にあるRESTAPIリンクを探し、その画面に移動してから、[ APIキーの作成]ボタンをクリックします。

[APIキーの作成]ボタンをクリックします。

次に、他の項目はそのままにして、[説明]フィールドに入力します。 これは、アクセスの目的を簡単に説明したものである必要があります。

新しいキーを作成し、詳細を入力します。

最後に、[ APIキーの生成]ボタンを選択し、WordPressが処理を実行するのを待ちます。 ここには、コンシューマキーとシークレットキー、さらに認証するためのQRコード、および将来APIアクセスを取り消すためのリンクが表示されます。 後で取得することはできないため、今すぐキーをコピーすることが重要です。

この時点で、コーディングを開始する準備が整いました。 これがあなたにとって新しいことであるならば、援助するために開発者を雇うことは良い考えです。 ただし、自分でジャンプしたい場合は、PostmanやInsomniaなどの「APIクライアント」を使用して、手間のかかる作業の多くを行うことができます。

Postmanツール。

WooCommerce APIの実際の使用方法については、このテーマに関する開発者のブログをご覧ください。 たとえば、IconicWPのJames Kempは、PHPWebアプリと少数のコードがeコマースストアに接続してそのデータを処理する方法についての有用な洞察を提供します。

結論

ユーザーと開発者の両方に優しいプラットフォームを選択することになると、WordPressは間違いなくナンバーワンです。 さらに、WooCommerceは、シンプルさ、パワー、柔軟性を求める店舗オーナーにも同様にフレンドリーです。 それを非常に適応性のあるものにしているのは、WooCommerce RESTAPIです。 これはかつては別個のエンティティでしたが、現在はメインのWordPress RESTAPIにマージされています。

この記事では、WooCommerce APIについて説明し、WooCommerceAPIで何ができるかを垣間見ることができます。 関連するコアコンセプトをしっかりと把握するか、必要な機能を実装するために開発者を雇うことを検討してください。 いずれにせよ、このAPIが提供するパワーは、店舗と収入に直接的なプラスの影響を与える可能性があります。

ストアにWooCommerceAPIを使用することを検討していますか？使用する場合、何が最も興奮しますか？ 以下のコメントセクションでお知らせください！

注目の画像クレジット：monkographic / shutdownstock.com