各製品の資料を入手。
詳細はこちら →Linux/Unix 上でPHP からGMO MakeShop のデータに接続・連携
CData ODBC ドライバを使って、Linux/Unix マシン上でGMO MakeShop のデータに連携可能なPHP アプリケーションを作成。PHP でのODBC ネイティブサポートを活用します。
最終更新日:2023-09-22
この記事で実現できるGMO MakeShop 連携のシナリオ
こんにちは!ドライバー周りのヘルプドキュメントを担当している古川です。
CData ODBC Driver for GMOMakeShop をLAMP またはWAMP スタックにドロップし、GMO MakeShop に接続されたWeb アプリケーションを構築します。本記事では、PHP のビルトインODBC 機能でGMO MakeShop のデータに接続し、クエリを実行して、結果を出力する手順を説明します。
CData ODBC ドライバとは?
CData ODBC ドライバは、以下のような特徴を持ったリアルタイムデータ連携ソリューションです。
- GMO MakeShop をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレミスデータソースに対応
- 多様なアプリケーション、ツールにGMO MakeShop のデータを連携
- ノーコードでの手軽な接続設定
- 標準 SQL での柔軟なデータ読み込み・書き込み
CData ODBC ドライバでは、1.データソースとしてGMO MakeShop の接続を設定、2.PHP 側でODBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。
UNIX/Linux マシンでCData ODBC Drivers を使用する
CData ODBC Drivers は、Ubuntu、Debian、RHEL、CentOS、Fedora など、Red Hat およびDebian ベースのさまざまなシステムでサポートされています。また、いくつかライブラリやパッケージが要求されることがありますが、それらの多くはシステムにデフォルトでインストールされています。サポートされているLinux オペレーティングシステムのバージョンと必要なライブラリの詳細については、インストール済みのもの、またはWeb 上にあるヘルプドキュメントの「はじめに」の章を参照してください。
ドライバーマネージャーをインストールする
ドライバーをインストールする前に、システムにドライバーマネージャーがあることを確認してください。この記事では、広くサポートされている無料のオープンソースODBC ドライバーマネージャーであるunixODBC を使用します。
Ubuntu のようなDebian ベースのシステムでは、APT パッケージマネージャーを使用してunixODBC をインストールできます。
$ sudo apt-get install unixODBC unixODBC-dev
Red Hat Linux ベースのシステムの場合は、yum またはdnf を使用してunixODBC をインストールできます。
$ sudo yum install unixODBC unixODBC-devel
unixODBC ドライバーマネージャーは、ドライバーの情報をodbcinst.ini ファイルから、データソースの情報をodbc.ini ファイルから読み取ります。 次のコマンドをターミナルに入力することで、システムの設定ファイルの場所を指定できます。
$ odbcinst -j
コマンドの出力は、登録されたODBC ドライバーおよびODBC データソースの設定ファイルの場所を表示します。 ユーザーデータソースにアクセスできるのは、odbc.ini ファイルがホームフォルダに格納されているユーザーアカウントだけです。システムデータソースには、すべてのユーザーがアクセスできます。 以下に、このコマンドの出力例を示します。
DRIVERS............: /etc/odbcinst.ini
SYSTEM DATA SOURCES: /etc/odbc.ini
FILE DATA SOURCES..: /etc/ODBCDataSources
USER DATA SOURCES..: /home/myuser/.odbc.ini
SQLULEN Size.......:8
SQLLEN Size........:8
SQLSETPOSIROW Size.:8
ドライバーをインストールする
標準パッケージ形式(Debian .deb パッケージ形式または.rpm ファイル形式)でドライバーをダウンロードすることができます。ファイルをダウンロードしたら、ターミナルからドライバーをインストールできます。
ドライバーインストーラーはドライバーをunixODBC に登録し、システムDSN を作成します。これは、後にODBC 接続をサポートするツールやアプリケーションで使用できます。
Ubuntu のようなDebian ベースのシステムでは、sudo またはroot で以下のコマンドを実行します。
$ dpkg -i /path/to/package.deb
Red Hat システムまたは.rpms をサポートするその他のシステムの場合は、sudo またはroot で以下のコマンドを実行します。
$ rpm -i /path/to/package.rpm
ドライバーがインストールされたら、unixODBC ドライバーマネージャーを使用し、登録されたドライバーと定義されたデータソースを一覧表示できます。
登録されているドライバーを一覧表示する
$ odbcinst -q -d
CData ODBC Driver for GMOMakeShop
...
定義されたデータソースを一覧表示する
$ odbcinst -q -s
CData GMOMakeShop Source
...
CData ODBC Driver for GMOMakeShop をunixODBC で使用するには、ドライバーがUTF-16 を使用するように設定されていることを確認します。そのために、インストール場所(通常はcdata.odbc.gmomakeshop.ini)のlib フォルダにある、ドライバー(cdata.odbc.gmomakeshop.ini)のINI ファイルを以下のように編集します。
cdata.odbc.gmomakeshop.ini
...
[Driver]
DriverManagerEncoding = UTF-16
DSN を変更する
ドライバーのインストールにより、システムDSN が事前定義されます。DSN を変更するには、システムデータソースファイル(/etc/odbc.ini)を編集し、必要な接続プロパティを定義します。さらに、$HOME/.odbc.ini での変更にルートアクセスを必要としない、ユーザー固有の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 を実行する場合に必要です。
/etc/odbc.ini または$HOME/.odbc.ini
[CData GMOMakeShop Source]
Driver = CData ODBC Driver for GMOMakeShop
Description = My Description
ShopId = MyShopId
ProductsAccessCode = MyProductsAccessCode
MembersAccessCode = MyMembersAccessCode
OrdersAccessCode = MyOrdersAccessCode
これらの構成ファイルの使用方法については、オンラインのヘルプドキュメントを参照してください。
接続を確立する
odbc_connect またはodbc_pconnect を呼び出して、GMO MakeShop への接続を開きます。 接続を閉じるには、odbc_close もしくはodbc_close_all を使います。
$conn = odbc_connect("CData ODBC GMOMakeShop Source","user","password");
接続はodbc_connect で開かれ、スクリプトが終わると終了します。odbc_pconnect メソッドで開いた接続は、スクリプトが終わっても開いたままです。これにより同じクレデンシャルであれば他のスクリプトで接続を共有することが可能です。スクリプト間で接続を共有することにより、システムリソースを節約し、クエリの実行を高速化できます。
$conn = odbc_pconnect("CData ODBC GMOMakeShop Source","user","password");
...
odbc_close($conn); //persistent connection must be closed explicitly
プリペアドステートメントを作成する
odbc_prepare を使って、プリペアドステートメントおよびパラメータライズドクエリを作成します。
$query = odbc_prepare($conn, "SELECT * FROM Products WHERE BrandCode = ?");
クエリを実行する
Prepared ステートメントをodbc_execute を使って実行します。
$conn = odbc_connect("CData ODBC GMOMakeShop Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Products WHERE BrandCode = ?");
$success = odbc_execute($query, array('99a87c0x3'));
Non-Parameterized クエリは、odbc_exec を使います。
$conn = odbc_connect("CData ODBC GMOMakeShop Source","user","password");
$query = odbc_exec($conn, "SELECT BrandCode, Price FROM Products");
結果の処理
odbc_fetch_array 関数の結果セット配列としてアクセスします。
$conn = odbc_connect("CData ODBC GMO MakeShop データ Source","user","password");
$query = odbc_exec($conn, "SELECT BrandCode, Price FROM Products");
while($row = odbc_fetch_array($query)){
echo $row["BrandCode"] . "\n";
}
odbc_result_all 関数で、結果セットをHTML テーブルとして表示します。
$conn = odbc_connect("CData ODBC GMO MakeShop データ Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM Products WHERE BrandCode = ?");
$success = odbc_execute($query, array('99a87c0x3'));
if($success)
odbc_result_all($query);
他のサンプルクエリ
ドライバーがサポートしているSQL の詳細は、ヘルプドキュメントを参照してください。上のサンプルは、PHP community documentation for all ODBC functions をGMO MakeShop 向けに変更したものです。
GMO MakeShop からPHP へのデータ連携には、ぜひCData ODBC ドライバをご利用ください
このようにCData ODBC ドライバと併用することで、270を超えるSaaS、NoSQL データをコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。
CData ODBC ドライバは日本のユーザー向けに、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。