はじめに
本記事では、グローバルで利用されているECプラットフォームShopifyの管理用API(REST Admin API)を利用する手順をご紹介します。
ShopifyのREST Admin APIのリファレンスはこちらからご覧いただけます。
Shopify REST Admin APIでアクセスできるデータ
Shopify REST Admin APIでアクセスできるデータは以下の通りです。
| 種類 | 備考 |
|---|---|
| Access APIs | 販売者から許可されたアクセスを表示および管理します。 |
| Analytics APIs | 販売者に詳細なレポートを提供して、ビジネスのパフォーマンスを分析できるようにします。 |
| Billing APIs | 1回限りの料金、固定月額料金、または使用状況に応じて変動する月額料金を徴収して、アプリの支払いを受け取ります。 |
| Customer APIs | マーチャントが顧客データを管理できるようにします。 |
| Discount APIs | マーチャントが柔軟な割引を提供できるようにします。 |
| Event APIs | イベントデータを取得するか、Webhookを登録して、アプリをマーチャントストアと同期し続けます。 |
| Inventory APIs | 複数の場所で在庫レベルを管理します。 |
| MarketingEvent | マーケティングイベントは、商品、コレクション、割引、ページ、ブログ投稿、その他の機能を販売するために、マーチャントに代わってアプリが実行するアクションを表します。 |
| Metafield | メタフィールドリソースを使用すると、他の管理APIリソースに追加情報を追加できます。メ |
| Online store APIs | 販売者のオンラインストアフロントとそのコンテンツを更新します。 |
| Order APIs | マーチャントに注文を受け取り、処理し、管理する新しい方法を提供します。 |
| Plus APIs | Shopify Plus専用のAPIを使用して、高GMVマーチャント向けのカスタム機能を作成します。 |
| Product APIs | 製品およびコレクションAPIを使用して、ストアのカタログにアクセスして操作します。 |
| Sales channel APIs | 独自の販売チャネルを作成します。販売チャネルは、モバイルアプリ、Webサイト、またはオンラインマーケットプレイスです。 |
| Shipping and fulfillment APIs | チェックアウト時にカスタム配送料金を表示するか、アプリをストアのフルフィルメントサービスとして登録してから、フルフィルメントを管理します。 |
| Shopify Payments APIs | Shopify Payments APIでは、次のリソースを使用して、マーチャントのShopify Paymentsアカウントに関する情報にアクセスできます。 |
| Store property APIs | ストアの構成を管理します。 |
| TenderTransaction | 入札取引はそれぞれ、マーチャントと顧客の間を通過するお金を表します。正の金額の入札取引は、顧客がマーチャントにお金を支払った取引を表します。マイナスの金額は、商人が顧客に返金した取引を表します。入札取引は、店舗の残高を変更する取引を表します。 |
※2020/02/06時点
Shopify REST Admin APIを利用する手順
プライベートアプリの作成、および、APIキーの発行
Shopify REST Admin APIへのアクセスするためのプライベートアプリを作成します。プライベートアプリの詳細はこちらからご覧いただけます。
まずはじめに、アプリ管理画面からプライベートアプリを管理のリンクをクリックします。
プライベートアプリの一覧が表示されますので、右上の「新しいプライベートアプリを作成する」ボタンをクリックします。
プライベートアプリ名、緊急連絡用開発者メールを入力して、Admin APIへのアクセス範囲を指定して保存します。アプリを作成して良いかダイアログが出てきますので確認してOKします。
プライベートアプリが正常に作成されるとAdminAPIの枠の中に、APIキーとパスワードが発行されます。これらの情報は後のAPIアクセスに必要な情報となりますので手元に控えてくだださい。なお、これらの情報が漏洩するとショップのデータにアクセスできてしまうので取り扱いにはご注意ください。
ブラウザからAPIにアクセス
上記プライベートアプリの「Admin API > URLの例」の下記形式のURL（HTTP認証）をコピーしてブラウザのURLに貼り付けてみます。
https://{APIキー}:{パスワード}@{サブドメイン}.myshopify.com/admin/api/2020-01/orders.json
サンプルURLはOrders（注文）エンドポイントとなりますので、注文データがJSONデータとして取得できます。
Postman からAPIにアクセス
続いて、API管理ツールのPostmanから実行してみましょう。認証方式はBasic Authを選択して、以下の通りセットします。
Method : GET URL : https://{サブドメイン}.myshopify.com/admin/api/2020-01/orders.json
Authorization : Basic Username : {APIキー} Password : {パスワード}
リクエストを実行してStatus 200、JSONレスポンスが返ってくれば成功です。
まとめ
以上が、ShopifyのREST Admin APIの利用方法のご紹介でした。弊社CData Software では、本Shopify REST Admin APIをSQLでCRUD操作可能なデータドライバ製品を開発販売しております。BIツールやExcel・MS-AccessといったOfficeツールからShopifyへのデータアクセスが可能な製品です。30日間ご利用いただける評価版もございますので是非こちらもお試しください。
おしまい
