JayDeBeApi を使って Python からAgileCRM のデータにアクセス

Python と Java がインストールされている環境であれば、Python スクリプトと標準 SQL を使ってAgileCRM のデータにアクセスできます。CData API Driver for JDBC と JayDeBeApi モジュールを組み合わせることで、Python からリモートのAgileCRM のデータを操作できます。CData ドライバーを使用することで、業界標準に準拠した実績のあるドライバーを Python という人気の高い言語で活用できます。この記事では、ドライバーを使って AgileCRM に SQL クエリを実行し、標準的な Python でAgileCRM のデータを可視化する方法を説明します。

JayDeBeApi モジュールを使用

JayDeBeApi は、JDBC（Java Database Connectivity）のブリッジとして機能する Python ライブラリで、Python プログラムから CData JDBC ドライバーを含む Java データベースとやり取りできるようになります。pip install コマンドでモジュールをインストールします。

pip install JayDeBeApi

JDBC URL を作成

JayDeBeApi をインストールしたら、SQL を使って Python からAgileCRM のデータを操作する準備が整います。

まず、Profile 接続プロパティをディスク上の AgileCRM プロファイルの場所に設定します（例：C:\profiles\Agilecrm.apip）。次に、ProfileSettings 接続プロパティを AgileCRM の接続文字列に設定します（以下を参照）。

AgileCRM API プロファイル設定

AgileCRM にログインし、「Admin Settings > Developers & API > REST API」に移動すると、API キーを確認できます。ドメインは、AgileCRM アカウントの URL に含まれるサブドメインです。

ビルトイン接続文字列デザイナー

JDBC URL の作成には、AgileCRM JDBC Driver に組み込まれている接続文字列デザイナーを使用してください。JAR ファイルをダブルクリックするか、コマンドラインから実行します。

java -jar cdata.jdbc.api.jar

接続プロパティを入力し、接続文字列をクリップボードにコピーします。

以下は、一般的な JDBC 接続文字列を含む変数の例です。

jdbc_url = "jdbc:api:Profile=C:\profiles\Agilecrm.apip;ProfileSettings='APIKey=your_api_key;Domain=your_domain;User=your_email';"

Python からAgileCRM のデータにアクセス

JDBC URL を設定したら、あとは JDBC ドライバーの JAR ファイルへの絶対パスだけが必要です。これはインストールディレクトリの "lib" フォルダにあります（Windows では "C:\Program Files\CData\CData API Driver for JDBC 20XX\lib\cdata.jdbc.api.jar"）。

注意: まだ設定していない場合は、JAVA_HOME 環境変数を Java のインストールディレクトリに設定してください。

以下のようなコードで AgileCRM からデータを読み取り、表示できます。

import jaydebeapi

#The JDBC connection string
jdbc_url = "jdbc:api:Profile=C:\profiles\Agilecrm.apip;ProfileSettings='APIKey=your_api_key;Domain=your_domain;User=your_email';"

username = "****"
password = "****"

#The absolute Path to the JDBC driver JAR file, typically:
jdbc_driver_jar = "C:\Program Files\CData\CData API Driver for JDBC 20XX\lib\cdata.jdbc.api.jar"

conn = jaydebeapi.connect(
   "cdata.jdbc.api.APIDriver",
   jdbc_url,
   [username, password],
   jdbc_driver_jar,
)

cursor = conn.cursor()
cursor.execute("SELECT * FROM Campaigns;")


results = cursor.fetchall()
for row in results:
    print(row)

cursor.close()
conn.close()

無料トライアルと詳細情報

CData API Driver for JDBC の 30 日間無料トライアルをダウンロードして、Python でリアルタイムのAgileCRM のデータを操作してみてください。ご不明な点がございましたら、サポートチームまでお問い合わせください。