はじめに
https://github.com/Shopify/shopify-app-js
https://github.com/Shopify/shopify-app-js/tree/main/packages/apps/shopify-api#readme
Shopify API Library for Node.jsとは、Shopify Admin APIを利用するための公式Node.js SDKです。このライブラリを使うことで、Shopify Admin APIや他のAPIに簡単にアクセスできます。
Shopify API Library for Node.js
- ShopifyのAdmin API、Storefront API、その他のAPIに簡単にアクセスできる。
- 認証やリクエストの構成を自動化。
- 特定のAPIバージョンやエンドポイントに対応。
インストール方法
まず、Node.jsプロジェクトでこのライブラリをインストールします。
npm install @shopify/shopify-api使用方法
ここでは、Shopify Admin APIを使って、メールアドレスでカスタマー情報を取得する例を示します。
// 必要なライブラリをインポート
import { shopifyApi, ApiVersion } from '@shopify/shopify-api';
// Shopify APIの初期設定
const shopify = shopifyApi({
apiKey: process.env.SHOPIFY_API_KEY,
apiSecretKey: process.env.SHOPIFY_API_SECRET,
apiVersion: ApiVersion.July24, // 使用するAPIバージョン
accessToken: process.env.SHOPIFY_ACCESS_TOKEN,
shop: 'your-store-name.myshopify.com', // ストアのドメイン
});
async function getCustomerByEmail(email) {
try {
// クエリを使ってカスタマー情報を取得
const customer = await shopify.rest.Customer.search({
query: `email:${email}`, // クエリ条件を指定
});
return customer;
} catch (error) {
console.error('Error fetching customer:', error);
throw error;
}
}
// 使用例
getCustomerByEmail('customer@example.com')
.then(customer => console.log(customer))
.catch(error => console.error(error));主要なポイント
@shopify/shopify-apiを使ってShopifyのAPIに簡単にアクセスできます。- Shopify Admin APIには、アクセスするためにAPIキーやアクセス・トークンが必要です。これらは環境変数（
.envファイルなど）に保存して使用します。 shopify.rest.Customer.searchなどのメソッドを使って、特定のカスタマー情報を検索・取得できます。クエリを使ってメールアドレスなどでカスタマーを検索することもできます。
参考リンク
このライブラリを使うことで、Shopify Admin APIとのやりとりが非常に簡単になります。