Magento 2 APIとは?

Magento Rest API workflow
Magento Rest API workflow

Magento APIは、Eコマースストアを効果的に管理する能力を提供することができるフレームワークです。今日の記事では、Magento 2 APIとは何かについての基本的な情報を提供したいと思います。

1. Magento 2 APIとは?

Magento web API は、Magento システムとの通信にウェブサービスを使用する手段を、ユーザーインテグレーターや開発者に提供するフレームワークです。このフレームワークの主な特徴は以下の通りです。

  • RESTとSOAPの両方に対応しています。Magento 2では、RESTとSOAPのウェブAPIのカバー率は同じです。
  • 3つの認証タイプ:
    • サードパーティのアプリケーションは、OAuth 1.0aで認証します。
    • モバイルのアプリケーションでは、トークンを使った認証を行います。
    • 管理者と顧客は、ログイン情報を使って認証します。
  • すべてのアカウントと統合機能がアクセスできるリソースが割り当てられます。リクエストを実行するために、APIフレームワークは、任意のコールが認証を持っているかどうかをチェックします。
  • 数行のxmlで、MagentoやサードパーティのサービスをWeb APIとして構成することができます。Web APIを構成するためには、XML要素と属性をwebapi.xml構成ファイルで定義する必要があります。なぜなら、設定ファイルでサービスを定義しなかった場合、そのサービスは公開されないからです。
  • 現在、フレームワークはCRUD(create, read, update, deleteの頭文字)と検索モデルに基づいているため、このシステムではWebhookはサポートされていません。
  • モバイルの帯域幅を節約するために、ウェブAPIレスポンスのフィールドフィルタリングがフレームワークでサポートされています。
  • 統合の効果を高めるために、1つのWeb APIコールで複数のサービスを同時に実行することが可能です。例えば、Web APIコールで商品を作成できるカタログでは、stock_itemオブジェクトとmedia_gallery_entriesオブジェクトがペイロードに含まれている場合、商品のインベントリとメディアもそのAPIコールで作成されます。

2. MagentoのWeb APIは何のために使われるのか?

APIを使ってさまざまな作業を行うことができます。ここではその例をご紹介します。

  • ユーザーがモバイルデバイスにダウンロードできる従来型のショッピングアプリを作成します。また、従業員がショールームでお客様の購入をサポートするために使用するアプリも作成できます。
  • SalesforceやXeroなどのCRMやERPのバックエンドシステムと統合する。
  • CMSと統合する。ただし、現時点ではコンテンツのタグ付けには対応していません。
  • サービスにアクセスするためのAJAXコールを行うJavaScriptウィジェットは、Magentoのストアフロントまたは管理パネルで作成できます。

3. 開始方法

まず最初に、Magento Admin でウェブサービスを登録する必要があります。ここでは、ウェブサービスを有効にするための手順をご紹介します。

ステップ1:Magento AdminでWebサービスユーザーを作成する

使用している認証がトークンベースの場合は、「システム」→「権限」→「すべてのユーザー」→「新しいユーザーの追加」を選択します。残りの2つの認証では、Adminでの新しいユーザーの作成は必要ありません。

ステップ2:Magento Adminで新しいインテグレーションを作成する

統合を作成するには、「システム」→「拡張機能」→「統合」→「新しい統合の追加」を選択します。統合機能がアクセスできるリソースが制限されていることを確認してください。

ステップ3:認証の設定

RESTまたはSOAPクライアントを使用して認証を設定することができます。

4. まとめ

以上、Magento 2 APIとは何か、それを使って何ができるのか、どうやって始めるのか、といった情報を提供してきましたが、いかがでしたでしょうか。

デモを申し込む

弊社の専門家は最適なソリューションをサポートさせて頂きます。

►►►サービスについて