こんにちは!ドライバー周りのヘルプドキュメントを担当している古川です。
ODBC Driver for GMOMakeShop とSQL Gateway を使用することで、MySQL インターフェースを使ってGMO MakeShop にクエリを実行できます。この記事では、MySQL Workbench からGMO MakeShop のデータにSQL クエリを投げてデータを取得する方法をご紹介します。
CData ODBC ドライバとは?
CData ODBC ドライバは、以下のような特徴を持ったリアルタイムデータ連携ソリューションです。
- GMO MakeShop をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレミスデータソースに対応
- 多様なアプリケーション、ツールにGMO MakeShop のデータを連携
- ノーコードでの手軽な接続設定
- 標準 SQL での柔軟なデータ読み込み・書き込み
CData ODBC ドライバでは、1.データソースとしてGMO MakeShop の接続を設定、2.MySQL Workbench 側でODBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。
CData ODBC ドライバのインストールとGMO MakeShop への接続設定
まずは、本記事右側のサイドバーからGMOMakeShop ODBC Driver の無償トライアルをダウンロード・インストールしてください。30日間無償で、製品版の全機能が使用できます。
未指定の場合は、データソース名(DSN)で必要な接続プロパティの値を指定します。ドライバーのインストールの最後にODBC アドミニストレーターが開きます。Microsoft ODBC データソースアドミニストレーターでDSN を作成及び設定する方法については、ヘルプドキュメントの[はじめに]チャプターを参照してください。
GMO MakeShop に接続するには、MembersAccessCode、OrdersAccessCode、ProductsAccessCode、およびShopId が必要です。
GMO MakeShop へのアクセスの設定
MembersAccessCode、OrdersAccessCode、ProductsAccessCode、およびShopId を取得するには、以下の手順に従ってください。
- GMO MakeShop には各API のAccessCode が必要です。
- GMO MakeShop Store Manager にログインし、メニューの「ショップ作成」をクリックします。
- 左ナビゲーションメニューの「外部システム連携」から任意の連携対象設定ををクリックします(メニューに表示されない場合は別途GMO MakeShop にご確認ください)。
- 商品データ連携設定の場合:認証コードの「発行」ボタンをクリックし、ProductsAccessCode を取得します。
- 注文データ連携設定の場合:最初に「注文情報参照」と「注文情報変更」の設定を選択します。選択後、認証コードの「発行」ボタンをクリックし、OrdersAccessCode を取得します。
- 会員データ連携設定の場合:最初に「会員情報の(参照・登録・変更・削除)」の設定を選択します。選択後、認証コードの「発行」ボタンをクリックし、MembersAccessCode を取得します。
- 会員認証連携設定の場合:認証コードの「発行」ボタンをクリックし、ProductsAccessCode を取得します。
GMO MakeShop アカウントの認証
次の接続プロパティを設定して接続します。
- ShopId:接続先のGMO MakeShop Store ID を設定。GMO MakeShop Store ID はログイン用の ID と同じです。
- OrdersAccessCode:「注文データ連携設定」から取得した「認証コード」を設定。このプロパティは Orders テーブルにアクセスする場合に必要です。
- ProductsAccessCode:「商品データ連携設定」から取得した「認証コード」を設定。このプロパティは Products テーブルにアクセスする場合に必要です。
- MembersAccessCode:「会員データ連携設定」から取得した「認証コード」を設定。このプロパティは Members テーブルにアクセスする場合に必要です。
- MemberAuthenticationCode:「会員認証連携設定」から取得した「認証コード」を設定。このプロパティは MemberAuthenticationConfirm
を実行する場合に必要です。
- Password:GMO MakeShop Store Manager のログインユーザーのパスワードを指定。このプロパティは
ProductCategoryRegistrationOrModification,ProductMemberGroupPriceRegistrationOrModification,ProductOptionRegistrationOrModification,ProductRegistrationOrModification
を実行する場合に必要です。
SQL Gateway を構成する
GMO MakeShop への接続を仮想MySQL データベースとして設定する方法については、SQL Gateway の解説記事 を参照してください。クライアントからのMySQL リクエストを受けるMySQL リモートサービスを構築します。このサービスは、SQL Gateway のUI で構成できます。
MySQL Workbench からGMO MakeShop をクエリ
以下のステップでは、MySQL Workbench からSQL Gateway で作成された仮想GMO MakeShop のデータベースに接続し、GMO MakeShop のデータをリアルタイムで操作するための基本的なクエリを発行する方法を説明します。
SQL Gateway を介してGMO MakeShop に接続
- MySQL Workbench で、[add a new MySQL connection]をクリックします。
- 接続(CData SQL Gateway for GMOMakeShop)に名前を付けます。
- Hostname、Port、Username のパラメータを設定し、SQL Gateway に接続します。
- Store in Vault をクリックしてパスワードを設定し、保存します。
- Test Connection をクリックして接続が正しく構成されていることを確認し、OK をクリックします。
GMO MakeShop のデータをクエリしてみる
- 作成した接続(CData SQL Gateway for GMOMakeShop)を開きます。
- [File]->[New Query Tab]と進みます。
- SELECT * FROM `CData GMOMakeShop Sys`.Products; のようなGMO MakeShop のデータを取得するSQL を書いて、実行します。
- 無事、GMO MakeShop のデータが取得できました。
おわりに
MySQL Workbench からリアルタイムGMO MakeShop のデータにアクセスすることで、MySQL データベースと同じようにGMO MakeShop をクエリおよび更新できます。CData ODBC Driver for GMOMakeShop とCData SQL Gateway の30日の無償評価版はこちらです。
CData ODBC ドライバは日本のユーザー向けに、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。