LINQPad でfreee Ordering のデータを操作する方法
CData ADO.NET Provider for API は、LINQ やEntity Framework などの標準のADO.NET インターフェースを使ってfreee Ordering の操作を実現します。この記事では、LINQPad から接続してLINQ クエリを実行する方法を説明します。
必要なもの
本記事の手順を実行してLINQPad からfreee Ordering に接続するには、以下の3つの製品が必要になります。
- freee Ordering の環境
- LINQPad
- CData ADO.NET Provider for API。右側のサイドバーから30日間無償トライアルがダウンロードできます
データモデルの作成
CData ADO.NET Provider for API およびLINQPad をダウンロード・インストールしたら、Visual Studio で新しいクラスライブラリプロジェクトを作成します。
ADO.NET Provider の利用に必要となるEF 6を設定する方法については、ヘルプドキュメントを参照してください。
プロジェクトを右クリックし、［追加］→［新しい項目］→［ADO.NET Entity Data Model］をクリックします。ダイアログが表示されたら、データベースから［Code First］を選択します。 ［New Connection］をクリックして、表示されたウィザードで接続文字列オプションを指定します。
- AuthScheme：OAuth に設定します。
- OAuthClientID：アプリ設定で指定されたOAuth クライアントID に設定します。
- OAuthClientSecret：アプリ設定で指定されたOAuth クライアントシークレットに設定します。
- CallbackURL：アプリ設定で指定したリダイレクトURI に設定します。
- InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使用してOAuthAccessToken を取得するプロセスを管理できます。
希望するテーブルおよびビューを選択して［Finish］をクリックし、データモデルを作成します。
- プロジェクトをビルドします。生成されたファイルを使ってLINQPad でfreee Ordering 接続を作成できます。
まずはOAuth アプリを作成します。https://app.secure.freee.co.jp/developers/applications にアクセスして、「新しいアプリケーションの作成」ボタンをクリックします。アプリケーション名を指定し、リダイレクトURL を設定して登録をクリックします。そうすると、クライアントシークレットとクライアントID が発行されます。
次に、プロファイルをダウンロードしてドライバーがアクセス可能な場所に配置します。こちらからプロファイルをダウンロードして、「C:/profiles/」 などに設置してください。
その後、Companies ビューからCompanyId を取得します。以下の接続プロパティを設定したら、接続する準備ができます。
一般的な接続文字列は次のとおりです。
Profile=freeedp.apip;ProfileSettings='CompanyId=1234567;';Authscheme=OAuth;InitiateOAuth=GETANDREFRESH;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;CallbackUrl=your_callback_url;
LINQPad でfreee Ordering のデータに接続
必要な接続プロパティを取得してデータモデルアセンブリを作成したら、以下の手順に従ってLINQPad でデータモデルを使いはじめましょう。
LINQPad を開き［接続の追加］をクリックします。
［Use a typed data context from your own assembly］オプションを選択します。
［Entity Framework DbContext］を選択します。
［Path to Custom Assembly］ボックスの横にある［参照］をクリックして、プロジェクトフォルダを参照します。bin フォルダの下の.dll または.exe を参照します。
- DbContext の名前を選択します。
- 接続文字列をApp.Config に保存した場合は、App.Config へのパスを指定します。
これでLINQPad 経由でfreee Ordering にクエリできます。サポートされたLINQ クエリの例は、ヘルプドキュメントの「LINQ およびEntity Framework」を参照してください。
