各製品の資料を入手。
詳細はこちら →
製品をチェック
SQLAlchemy ORM を使って、Python でShipStation のデータに連携する方法
CData Python Connector を使って、Python アプリケーションおよびスクリプトからSQLAlchemy 経由でShipStation にOR マッピング可能に。
最終更新日：2023-09-23
この記事で実現できるShipStation 連携のシナリオ
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
Pythonエコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for ShipStation は、pandas、Matplotlib モジュール、SQLAlchemy ツールキットから使用することで ShipStation にデータ連携するPython アプリケーションを構築し、ShipStation のデータを可視化できます。 本記事では、SQLAlchemy でShipStation に連携して、データを取得、 する方法を説明します。
CData Python Connectors の特徴
CData Python Connectors は、以下のような特徴を持った製品です。
- ShipStation をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレデータソースに対応
- Python をはじめとする多様なデータ分析・BI ツールにShipStation のデータを連携
- ノーコードでの手軽な接続設定
CData Python Connectors では、1.データソースとしてShipStation の接続を設定、2.Python からPython Connectors との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。
必要なモジュールのインストール
pip でSQLAlchemy ツールキットをインストールします：
pip install sqlalchemy
モジュールのインポートを忘れずに行います：
import sqlalchemy
Python でShipStation のデータをモデル化
次は、接続文字列で接続を確立します。create_engine 関数を使って、ShipStation のデータに連携するEngne を作成します。
engine = create_engine("shipstation///?APIKey='YourAPIKey'&APISecret='YourAPISecret'")
ShipStation 接続プロパティの取得・設定方法
ShipStation への接続には、BASIC 認証標準を使います。
- ShipStation アカウントにログインします。
- 右上隅にある［設定］アイコンをクリックします。左側にカラムメニューが表示されます。
- ［アカウント］->［API 設定］をクリックします。
- ［API 設定］ページで、API Key とAPI Secret を書き留めます。
ShipStation への認証
- APIKey：［API 設定］ページのAPI Key に設定します。
- APISecret：［API 設定］ページのSecret key に設定します。
ShipStation のデータのマッピングクラスの宣言
接続を確立したら、OR マッパーでモデル化するテーブルのマッピングクラスを宣言します。本記事では、Tags テーブルを使います。sqlalchemy.ext.declarative.declarative_base 関数を使って、新しいクラスにフィールド（カラム）を定義します。
base = declarative_base() class Tags(base): __tablename__ = "Tags" Id = Column(String,primary_key=True) Color = Column(String) ...
ShipStation のデータをクエリ
マッピングクラスができたので、セッションオブジェクトを使ってデータソースをクエリすることができます。セッションにEngine をバインドして、セッションのquery メソッドにマッピングクラスを提供します。
query メソッドを使う
engine = create_engine("shipstation///?APIKey='YourAPIKey'&APISecret='YourAPISecret'")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Tags).filter_by(CustomerId="1368175"):
print("Id: ", instance.Id)
print("Color: ", instance.Color)
print("---------")
ほかの方法としては、execute メソッドを適切なテーブルオブジェクトに使うことが可能です。以下のコードはアクティブなsession に対して有効です。
execute メソッドを使う
Tags_table = Tags.metadata.tables["Tags"]
for instance in session.execute(Tags_table.select().where(Tags_table.c.CustomerId == "1368175")):
print("Id: ", instance.Id)
print("Color: ", instance.Color)
print("---------")
より複雑なクエリとして、JOIN、集計、Limit などが利用可能です。詳細はヘルプドキュメントをご覧ください。
ShipStation からPython へのデータ連携には、ぜひCData Python Connector をご利用ください
このようにCData Python Connector と併用することで、270を超えるSaaS、NoSQL データをPython からコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。
日本のユーザー向けにCData Python Connector は、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。
関連コンテンツ
