【徹底解説】freee請求書 のデータをSQL Server のリンクサーバーにノーコードで連携する方法

兵藤朋代
兵藤朋代
コンテンツスペシャリスト
業務で利用しているSQL Server にfreee請求書 のデータを統合したい方向けに、リンクサーバーを活用したアプローチを紹介。CData ODBC DriverのSQL Gateway 機能を使うことで3ステップ設定。使い慣れたSQL Server からfreee請求書 データに手軽にアクセスできるようになります。



本記事では、SQL ServerのTDS Remoting 機能を使ってfreee請求書 にリンクサーバーとしてシームレスに連携する方法を解説します。この連携には、CData ODBC Driverに同梱されているSQL Gateway を使用します。この方法により、SQL Server のインターフェースからfreee請求書 への読み書き双方向のアクセスが可能になり、既存のSQL Server 環境で外部データを活用できるようになります。スクリーンショット付きで紹介していくので、初心者の方でも簡単に設定できます！

freee請求書 をSQL Server のリンクサーバーとして利用する3つの主要シナリオ

  • SQL Server に接続しているアプリケーションでfreee請求書 のデータを利用したいがデータ接続を増やしたくない
  • freee請求書 のデータをSQL Server のデータや他のリンクサーバーのデータをJOIN などして使いたい
  • 利用したいミドルウェア・BI ツールなどにODBC やJDBC の汎用のインターフェースがないが、SQL Server には接続できる

【準備編】freee請求書 ODBC DSNの設定方法

まずは、本記事右側のサイドバーからAPI ODBC Driver の無償トライアルをダウンロード・インストールしてください。ODBC ドライバーのインストール完了時にODBC DSN 設定画面が立ち上がります。または、Microsoft ODBC データソースアドミニストレーターを使ってDSN を作成および設定できます。

まずはOAuth アプリを作成します。https://app.secure.freee.co.jp/developers/applications にアクセスして、「新しいアプリケーションの作成」ボタンをクリックします。アプリケーション名を指定し、リダイレクトURL を設定して登録をクリックします。そうすると、クライアントシークレットとクライアントID が発行されます。

次に、プロファイルをダウンロードしてドライバーがアクセス可能な場所に配置します。こちらからプロファイルをダウンロードして、「C:/profiles/」 などに設置してください。

その後、Companies ビューからCompanyId を取得します。以下の接続プロパティを設定したら、接続する準備ができます。

  • AuthScheme：OAuth に設定します。
  • OAuthClientID：アプリ設定で指定されたOAuth クライアントID に設定します。
  • OAuthClientSecret：アプリ設定で指定されたOAuth クライアントシークレットに設定します。
  • CallbackURL：アプリ設定で指定したリダイレクトURI に設定します。
  • InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使用してOAuthAccessToken を取得するプロセスを管理できます。

【設定手順1】SQL Gateway でfreee請求書 ODBC DSN をセットアップする方法

CData ODBC ドライバにはSQL Gateway が同梱されています。このSQL Gateway に、freee請求書 ODBC Driver をサービスとして設定します。

  1. 「スタート」画面から「SQL Gateway」を起動します。青い「C」のSQL Gateway ロゴが右下のインジケータに表示されます。 アプリケーションコンソールが開かない場合には、SQL Gateway アイコンを右クリックして、「Open Application」をクリックしてください。
  2. アプリケーションコンソールの「Service」タブを開いて、「Add」をクリックして、新しいODBC データソースを設定します。
  3. freee請求書 ODBC の設定を行います。
    サービス名:任意
    リモーティングDB:TD(SQL Server）を選択
    データソース:ドロップダウンでCData freee請求書 Source Sys を選択
    ポート:使用していないポートを選択
    CData freee請求書 ODBC Driver設定画面 - SQL Gatewayでの設定方法
  4. 次に「ユーザー」タブ→「追加」からユーザーを登録します。
    ユーザー毎にFull アクセスか、Readonly か、None の権限を選択できます。
    複数のODBC データソースがある場合には、データソース毎に権限の設定が可能です。
    SQL Gateway ユーザー権限設定画面 - freee請求書データアクセス権限の設定方法
    「OK」を押して、ユーザー登録を完了します。 その後「変更を保存」で設定を保存します。
  5. SQL Gateway の「サービス」タブで「開始」ボタンを押して、サービスを起動します。サービスの左側の〇が緑色になれば、サービスは起動中です。

【設定手順2】SQL Server でfreee請求書 リンクサーバーを構築する方法

SQL Gateway 側でサービスの設定が終わったら、SQL Server 側でfreee請求書 サービスをリンクサーバーとして使う設定をしましょう。

  1. SQL Server Management Studio (SSMS) を開きます。
    オブジェクトエクスプローラーの「サーバーオブジェクト」で「リンクサーバー」を右クリックして、「新しいリンクサーバー」をクリックします。
  2. 新しいリンクサーバーの設定画面の「全般」で、以下を入力します。
    サーバー種類：その他データソース
    プロバイダー：Microsoft OLE DB Driver for SQL Server
    データソース：この例の場合、localhost, 1433
    カタログ：ODBC DSN 名を入力
    SQL Server リンクサーバー設定画面 - freee請求書をリンクサーバーとして追加する方法
  3. また、「セキュリティ」では、「このセキュリティコンテキスト」を選択して、リモートログインにSQL Gateway にユーザー設定したUser 名とPassword を入力します。

これで、リンクサーバーの設定は終わりなので、「OK」を押して設定を保存します。

【活用例1】SSMS（SQL Server Management Studio）でfreee請求書 データを操作する方法

SSMS のオブジェクトエクスプローラーのリンクサーバー下にfreee請求書 のリンクサーバーが作成され、「テーブル」下にfreee請求書 のデータがアプリ単位でテーブルが生成されます。
新しいクエリを選択し、freee請求書 のデータを取得してみます。

実践的なSQL クエリの例と解説

SELECT * from リンクサーバー名.CData freee請求書 Source Sys（ODBC DSN 名）.freee請求書.テーブル名

このように、API のリクエストではなく通常のSQL 構文でデータを扱うことが可能になっています

【活用例2】Visual Studio からfreee請求書 のリンクサーバーに連携する方法

Visual Studio のサーバーエクスプローラーの「データ接続」を右クリックし、「接続の追加」をクリックして、データソースの選択画面を開きます。 データソースの選択画面でデータソースを「Microsoft SQL Server 」に選択して、「続行」を押します。

Visual Studio での接続設定とクエリ実行手順

「接続の追加」画面で、以下を入力します。
サーバー名:SQL Server のサーバー名
認証:任意の認証方式
データベース名の選択または入力:※master など
※リンクサーバーを直接データベース名として入力することはできないようです。なので上位のデータベース名で設定しておきます。

Visual Studio でのfreee請求書リンクサーバー接続設定画面 - データ連携の設定方法

「テスト接続」をして大丈夫であれば、「OK」を押して設定を完了させます。

「新しいクエリ」で、SQL でSELECT 文を書いてデータを取得してみます。 

SELECT * from リンクサーバー名.CData freee請求書 Source Sys（ODBC DSN 名）.freee請求書.テーブル名

このように、通常のSQL Server のリンクサーバーと同じようにVisual Studio 内freee請求書 のデータを扱うことが可能になります。 他のIDE でもSQL Server にアクセスする方法でfreee請求書 のデータにSQL でアクセスが可能になります。
複数データソースのJOIN などを行う場合には大変便利です。

【応用編】freee請求書 データとSQL Server データを組み合わせた高度な活用例

リンクサーバーの真価は、異なるデータソースを組み合わせた分析や処理にあります。以下に実践的な活用例をご紹介します。

複数データソースの結合（JOIN）によるデータ統合

SELECT
  s.customer_id,
  s.customer_name,
  o.order_id,
  o.order_date,
  o.total_amount
FROM
  Sales.Customers s
JOIN
  リンクサーバー名.CData freee請求書 Source Sys.freee請求書.Orders o
ON
  s.customer_id = o.customer_id
WHERE
  o.order_date > '2023-01-01'
ORDER BY
  o.total_amount DESC

このクエリ例では、SQL Server内の顧客データとfreee請求書 内の注文データを顧客IDで結合し、2023年以降の注文を金額順に表示しています。

おわりに

このようにCData ODBC ドライバと併用することで、freee請求書 を含む270を超えるSaaS、NoSQL データをSQL Server に連携できます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービ スやNoSQL と合わせて活用してみてください。

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

API Driver で freee請求書 のライブデータに接続

freee請求書 に接続

この記事の内容

関連記事