PyCharm でCData ODBC Driver を使ってYotpo に接続

古川えりか
古川えりか
コンテンツスペシャリスト
CData ODBC Driver を使用して、ODBC データソースとしてPyCharm からYotpo に接続します。



CData ODBC Drivers は、ODBC ドライバーをサポートするあらゆる環境から利用可能です。本記事では、PyCharm からのCData ODBC Driver for API の利用を説明します。CData ODBC Deriver をデータソースとして設定する方法、データソースをクエリして結果を表示するためのPyCharm の簡単なコードを含みます。

はじめに、このチュートリアルではCData ODBC Driver for API とPyCharm が、既にインストールされていることを前提としています。

Pyodbc をプロジェクトに追加

以下のステップに従って、pyodbc モジュールをプロジェクトに追加します。

  1. [File]->[Settings]とクリックして[project settings]ウィンドウを開きます。
  2. [Project: YourProjectName]メニューから[Project Interpreter]をクリックします。
  3. pyodbc を追加するため、+ ボタンをクリックしてpyodbc と入力します。
  4. [Install Package]をクリックしてpyodbc をインストールします。

CData ODBC ドライバとは?

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

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

CData ODBC ドライバでは、1.データソースとしてYotpo の接続を設定、2.PyCharm 側でODBC Driver との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

CData ODBC ドライバのインストールとYotpo への接続設定

まずは、本記事右側のサイドバーからAPI ODBC Driver の無償トライアルをダウンロード・インストールしてください。30日間無償で、製品版の全機能が使用できます。

これで、ODBC 接続文字列またはDSN で接続できます。お客様のOS でDSN を作成するためのガイドについては、CData ドライバードキュメントの[はじめに]セクションを参照してください。

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

Yotpo API プロファイル設定

Yotpo への認証には、Yotpo の AppKey と AppSecret を使った OAuth 2.0 クライアントクレデンシャルフローを利用できます。

Yotpo API を使用するには、AppKey と AppSecret を持つ Yotpo ストアアカウントが必要です。これらの認証情報は、Yotpo ダッシュボードの「Account Settings」>「Store」で確認できます。

以下の接続プロパティを設定すると、接続できるようになります。

  • AuthScheme:OAuthClient に設定します。
  • InitiateOAuth:GETANDREFRESH に設定します。InitiateOAuth を使うと、OAuthAccessToken を取得するプロセスを管理できます。
  • OAuthClientId:Yotpo の AppKey に設定します。
  • OAuthClientSecret:Yotpo の AppSecret に設定します。

以下はDSN の構文です。


[CData API Source]
Driver = CData ODBC Driver for API
Description = My Description
Profile = C:\profiles\Yotpo.apip
AuthScheme = OAuthClient
InitiateOAuth = GETANDREFRESH
OAuthClientId = your_app_key
OAuthClientSecret = your_app_secret

Yotpo へのクエリの実行

Cursor をインスタンス化し、Cursor クラスのexecute メソッドを使用してSQL ステートメントを実行します。


import pyodbc

cnxn = pyodbc.connect('DRIVER={CData ODBC Driver for API};Profile = C:\profiles\Yotpo.apip;AuthScheme = OAuthClient;InitiateOAuth = GETANDREFRESH;OAuthClientId = your_app_key;OAuthClientSecret = your_app_secret;')
cursor = cnxn.cursor()
cursor.execute("SELECT TotalReview, AverageScore FROM ProductBottomLine WHERE ExternalProductId = 'my-product-sku'")
rows = cursor.fetchall()
for row in rows:
  print(row.TotalReview, row.AverageScore)

CData ODBC Driver を使用してPyCharm でYotpo に接続すると、Yotpo にアクセスできるPython アプリケーションを標準データベースのように構築できるようになります。このチュートリアルに関する質問、コメント、フィードバックがある場合には、[email protected] までご連絡ください。

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

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

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

はじめる準備はできましたか?

API Driver で Yotpo のライブデータに接続

Yotpo に接続