製品をチェック

PingOne ODBC Driver の30日間無償トライアルをダウンロード

30日間の無償トライアルへ

製品の詳細

PingOne ODBC Driver

お困りの点はございませんか？

類似の事例やソリューションを探す

データ連携のスペシャリストにご相談ください

PingOne 連携について相談する

Linux/Unix 上でPHP からPingOne のデータに接続・連携

CData ODBC ドライバを使って、Linux/Unix マシン上でPingOne のデータに連携可能なPHP アプリケーションを作成。PHP でのODBC ネイティブサポートを活用します。

古川えりか
コンテンツスペシャリスト
最終更新日：2023-09-22

この記事で実現できるPingOne 連携のシナリオ

CData

PHP（Linux）

こんにちは！ドライバー周りのヘルプドキュメントを担当している古川です。

CData ODBC Driver for PingOne をLAMP またはWAMP スタックにドロップし、PingOne に接続されたWeb アプリケーションを構築します。本記事では、PHP のビルトインODBC 機能でPingOne のデータに接続し、クエリを実行して、結果を出力する手順を説明します。

CData ODBC ドライバとは？

CData ODBC ドライバは、以下のような特徴を持ったリアルタイムデータ連携ソリューションです。

PingOne をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレミスデータソースに対応
多様なアプリケーション、ツールにPingOne のデータを連携
ノーコードでの手軽な接続設定
標準 SQL での柔軟なデータ読み込み・書き込み

CData ODBC ドライバでは、1.データソースとしてPingOne の接続を設定、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 PingOne
...

定義されたデータソースを一覧表示する


$ odbcinst -q -s
CData PingOne Source
...

CData ODBC Driver for PingOne をunixODBC で使用するには、ドライバーがUTF-16 を使用するように設定されていることを確認します。そのために、インストール場所（通常はcdata.odbc.pingone.ini）のlib フォルダにある、ドライバー（cdata.odbc.pingone.ini）のINI ファイルを以下のように編集します。

cdata.odbc.pingone.ini


...

[Driver]
DriverManagerEncoding = UTF-16

DSN を変更する

ドライバーのインストールにより、システムDSN が事前定義されます。DSN を変更するには、システムデータソースファイル（/etc/odbc.ini）を編集し、必要な接続プロパティを定義します。さらに、$HOME/.odbc.ini での変更にルートアクセスを必要としない、ユーザー固有のDSN を作成することができます。

PingOne に接続するには以下のプロパティを設定します。

Region：自身のPingOne 組織のデータがホスティングされている地域。
AuthScheme：PingOne に接続する際に使用する認証の種類。
WorkerAppEnvironmentId （デフォルトのPingOne ドメインを使用する場合に必要）、またはAuthorizationServerURL のいずれかで、下で説明するように設定します。

WorkerAppEnvironmentId の設定

WorkerAppEnvironmentId は、Worker アプリケーションが存在するPingOne 環境のID です。このパラメータは、環境がデフォルトのPingOne ドメイン（auth.pingone）を利用している場合のみ使用されます。これは、ヘルプドキュメントのカスタムOAuth アプリケーションの作成で説明するように、PingOne への認証に使用するカスタムOAuth アプリケーションを作成した後に設定します。

はじめに、このプロパティの値を見つけます。

自身のPingOne 組織のホームページからナビゲーションサイドバーに移動し、Environments をクリックします。
OAuth / Worker のカスタムアプリケーションを作成した環境（通常はAdministrators）を見つけ、Manage Environment をクリックします。環境のホームページが表示されます。
環境のホームページのナビゲーションサイドバーで、Applications をクリックします。
リストから、OAuth またはWorker アプリケーションの詳細を見つけます。
Environment ID フィールドの値をコピーします。以下の例に似たものになるはずです：
WorkerAppEnvironmentId='11e96fc7-aa4d-4a60-8196-9acf91424eca'

次に、WorkerAppEnvironmentId をEnvironment ID フィールドの値に設定します。

AuthorizationServerURL の設定

AuthorizationServerURL は、お使いのアプリケーションが配置されている環境のPingOne 認可サーバーのベースURL です。このプロパティは、PingOne プラットフォームAPI ドキュメントで説明されているように、環境にカスタムドメインを設定した場合にのみ使用されます。 Custom Domains を参照してください。

OAuth でのPingOne への認証

PingOne はOAuth とOAuthClient 認証の両方をサポートしています。上述の設定手順に加え、OAuth またはOAuthCliet 認証をサポートするために、さらに2つの手順を完了する必要があります。

ヘルプドキュメントのカスタムOAuth アプリケーションの作成で説明するように、カスタムOAuth アプリケーションを作成して設定します。
ドライバーがデータモデル内のエンティティにアクセスできるようにするには、ヘルプドキュメントのAdministrator Roles での説明のとおり、使用するアドミンユーザー / ワーカーアプリケーションに対して正しいロールを設定していることを確認してください。
以下のサブセクションで説明されているように、選択した認証スキームと認証フローに適切なプロパティを設定します。

OAuth（認可コードグラント）

AuthScheme をOAuth に設定します。

デスクトップアプリケーション

OAuth アクセストークンの取得およびリフレッシュ

以下を設定して、接続してください。

InitiateOAuth：GETANDREFRESH。繰り返しOAuth の交換を行ったり、手動でOAuthAccessToken を設定する必要をなくすには、InitiateOAuth を使用します。
OAuthClientId：カスタムOAuth アプリケーションを作成した際に取得したClient ID。
OAuthClientSecret：カスタムOAuth アプリケーションを作成した際に取得したClient Secret。
CallbackURL：カスタムOAuth アプリケーションの登録時に定義したリダイレクトURI。例：https://localhost:3333

接続すると、本製品はデフォルトブラウザでPingOne のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。ドライバーはこれでOAuth プロセスを完了します。

ドライバーはPingOne からアクセストークンを取得し、それを使ってデータをリクエストします。
OAuth 値はOAuthSettingsLocation で指定された場所に保存され、接続間で永続化されるようにします。

ドライバーはアクセストークンの期限が切れると自動的にリフレッシュします。

Web アプリケーションやヘッドレスマシン、クライアントクレデンシャルグラントを含むその他のOAuth メソッドについては、ヘルプドキュメントを参照してください。

/etc/odbc.ini または$HOME/.odbc.ini


[CData PingOne Source]
Driver = CData ODBC Driver for PingOne
Description = My Description
AuthScheme = OAuth
WorkerAppEnvironmentId = eebc33a8-xxxx-4f3a-yyyy-d3e5262fd49e
Region = NA
OAuthClientId = client_id
OAuthClientSecret = client_secret

これらの構成ファイルの使用方法については、オンラインのヘルプドキュメントを参照してください。

接続を確立する

odbc_connect またはodbc_pconnect を呼び出して、PingOne への接続を開きます。接続を閉じるには、odbc_close もしくはodbc_close_all を使います。


$conn = odbc_connect("CData ODBC PingOne Source","user","password");

接続はodbc_connect で開かれ、スクリプトが終わると終了します。odbc_pconnect メソッドで開いた接続は、スクリプトが終わっても開いたままです。これにより同じクレデンシャルであれば他のスクリプトで接続を共有することが可能です。スクリプト間で接続を共有することにより、システムリソースを節約し、クエリの実行を高速化できます。


$conn = odbc_pconnect("CData ODBC PingOne Source","user","password");
...
odbc_close($conn); //persistent connection must be closed explicitly

プリペアドステートメントを作成する

odbc_prepare を使って、プリペアドステートメントおよびパラメータライズドクエリを作成します。


$query = odbc_prepare($conn, "SELECT * FROM [CData].[Administrators].Users WHERE EmployeeType = ?");

クエリを実行する

Prepared ステートメントをodbc_execute を使って実行します。


$conn = odbc_connect("CData ODBC PingOne Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM [CData].[Administrators].Users WHERE EmployeeType = ?");
$success = odbc_execute($query, array('Contractor'));

Non-Parameterized クエリは、odbc_exec を使います。


$conn = odbc_connect("CData ODBC PingOne Source","user","password");
$query = odbc_exec($conn, "SELECT Id, Username FROM [CData].[Administrators].Users WHERE EmployeeType = 'Contractor'");

結果の処理

odbc_fetch_array 関数の結果セット配列としてアクセスします。


$conn = odbc_connect("CData ODBC PingOne データ Source","user","password");
$query = odbc_exec($conn, "SELECT Id, Username FROM [CData].[Administrators].Users WHERE EmployeeType = 'Contractor'");
while($row = odbc_fetch_array($query)){
 echo $row["Id"] . "\n";
}

odbc_result_all 関数で、結果セットをHTML テーブルとして表示します。


$conn = odbc_connect("CData ODBC PingOne データ Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM [CData].[Administrators].Users WHERE EmployeeType = ?");
$success = odbc_execute($query, array('Contractor'));
if($success)
  odbc_result_all($query);

他のサンプルクエリ

ドライバーがサポートしているSQL の詳細は、ヘルプドキュメントを参照してください。上のサンプルは、PHP community documentation for all ODBC functions をPingOne 向けに変更したものです。

PingOne からPHP へのデータ連携には、ぜひCData ODBC ドライバをご利用ください

このようにCData ODBC ドライバと併用することで、270を超えるSaaS、NoSQL データをコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。

CData ODBC ドライバは日本のユーザー向けに、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。

無償トライアルへ

お問い合わせ

ソリューション

サポート

ブログへ →

ナレッジベース