QuickBooks Online のデータをAI アシスタントのPEP から利用する方法

杉本和也
杉本和也
リードエンジニア
AI アシスタントPEP から QuickBooks Online のデータに連携し、チャットボットでリアルタイムQuickBooks Online のデータを使う方法



CData API Server と ADO.NET Provider / JDBC Driver for QuickBooksOnline を使って、AI アシスタントPEP(https://pep.work/) から QuickBooks Online に接続して、チャットボットでリアルタイムQuickBooks Onlineデータを使った応答を可能にする方法を説明します。

QuickBooks Online データ連携について

CData は、QuickBooks Online のライブデータにアクセスし、統合するための最も簡単な方法を提供します。お客様は CData の接続機能を以下の目的で使用しています：

  • フィルターや集計などの複雑な操作に対するプッシュダウンクエリ最適化により、高性能なデータ読み取りを実現します。
  • QuickBooks Online データの読み取り、書き込み、更新、削除ができます。
  • SQL ストアドプロシージャを使用して、レポートの実行、添付ファイルのダウンロード、請求書の送信や無効化をコードから直接実行できます。
  • OAuth と TLS 1.2、SHA-256、ECC などの最新の暗号化を使用して安全に接続できます。

多くのユーザーは、Power BI や Excel などのお気に入りの分析ツールからライブ QuickBooks Online データにアクセスしたり、フェデレートアクセスでデータベースから直接アクセスしたり、CData ソリューションを使用して QuickBooks Online データを B2B コミュニケーション用の自動化ワークフローに簡単に統合したりしています。

お客様が CData の QuickBooks Online ソリューションで問題を解決している方法については、ブログをご覧ください：https://jp.cdata.com/blog/360-view-of-your-customers


はじめに


API Server の設定

以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなQuickBooks Online OData サービスを作成していきましょう。

QuickBooks Online への接続

PEP からQuickBooks Online のデータを操作するには、まずQuickBooks Online への接続を作成・設定します。

  1. API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。 接続を追加
  2. 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「QuickBooks Online」を選択します。
  3. 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
    CData コネクタの追加方法はこちら >>
  4. それでは、QuickBooks Online への接続設定を行っていきましょう！ 接続設定

  5. QuickBooks Online への接続にはOAuth 認証標準を使います。Embedded Credentials を使用すると、接続プロパティを設定せずに接続できます。接続すると、CData 製品はデフォルトブラウザでOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えるだけです。CData 製品がOAuth プロセスを完了します。

    詳細はヘルプドキュメントを参照してください。

  6. 接続情報の入力が完了したら、「保存およびテスト」をクリックします。

QuickBooks Online への接続にはOAuth 認証標準を使います。Embedded Credentials を使用すると、接続プロパティを設定せずに接続できます。接続すると、CData 製品はデフォルトブラウザでOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えるだけです。CData 製品がOAuth プロセスを完了します。

詳細はヘルプドキュメントを参照してください。

API Server のユーザー設定

次に、API Server 経由でQuickBooks Online にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。

  1. 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
  2. 次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
  3. その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。

QuickBooks Online 用のAPI エンドポイントの作成

ユーザーを作成したら、QuickBooks Online のデータ用のAPI エンドポイントを作成していきます。

  1. まず、「API」ページに移動し、 「 テーブルを追加」をクリックします。
  2. アクセスしたい接続を選択し、次へをクリックします。
  3. 接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。

OData のエンドポイントを取得

以上でQuickBooks Online への接続を設定してユーザーを作成し、API Server でQuickBooks Online データのAPI を追加しました。これで、OData 形式のQuickBooks Online データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。

オンプレミスDB やファイルからのAPI Server 使用（オプション）

オンプレミスRDB やExcel/CSV などのファイルのデータを使用する場合には、API Server のCloug Gateway / SSH ポートフォワーディングが便利です。是非、Cloud Gatway の設定方法 記事を参考にしてください。

PEP でQuickBooks Online のデータをチャットで使う設定

前項まででAPI ができたので、ここからはPEP 側での設定作業です。

PEP でQuickBooks Online のAPI をコールするシナリオを作成

PEP 側ではあらかじめSlack などのアプリケーションを構成しておきます。ここにAPI Server をコールするAI アシスタントのシナリオを追加していきます。

PEP
  • 「会話編集」→「シナリオ」に移動し、新しいシナリオを作成します。
    • PEP
  • シナリオ名を入力します。この例では、条件はSlack Homeを　選択しています。
    • PEP
  • 「新規作成」ボタンをクリックすると、以下のようなシナリオエディタ画面に移動します。これでシナリオを作成する準備ができました。
    • PEP

QuickBooks Online のAPI の接続箇所の設定

具体的にAPI連携を含めたシナリオを作っていきます。

  • 最初に検索したい文字列を受け取るための対話ノードを配置して、以下のように構成します。
    • PEP
  • ポイントは分岐条件で「以下のすべての会話」、発言内容の記憶で「film_name」として、会話した内容を変数に保存することです。
    • PEP
  • 対話ノードを配置したら、APIノードを追加して、対話ノードから接続していきます。
    • PEP
  • APIノードでは、以下のように CData API Server　へのリクエストを構成します。
    ポイントは2つです。CData API Server は Filter　機能によって、取得するデータを絞り込むことができます。その指定が「$filter=contains(title,'{{ state.scenario_4.form.film_name }}')」の部分です。 「{{ state.scenario_4.form.film_name }}」は直前の対話ノードで設定した変数をパラメータとして渡しています。「scenario_4」はPEP　のシナリオIDですので、作成したシナリオに合わせて変更してください。
  • HTTPヘッダーにAPI Server　のユーザートークンを指定します。
    • API名：任意の名前を設定
    • URL：http://apiserverurl/api.rsc/film_list?$filter=contains(title,'{{ state.scenario_4.form.film_name }}')
    • HTTPメソッド：GET
    • Content-Type：JSON
    • HTTPヘッダー：キー「x-cdata-authtoken」、値「予め取得したAPI Serverのトークン」を指定
    • PEP

これで保存すると、API　ノードが使えるようになります。

取得したQuickBooks Online からのレスポンスの表示方法

最後に後続の対話ノードを構成し、取得した検索結果を表示します。

PEP

対話ノードの応答文には、以下のような文章を埋め込みます。

検索結果は以下のとおりです。

    {% for item in state.scenario_4.api_response.film_search.value %}
    フィルムID：{{ item.FID }}
    タイトル : {{ item.title }}
    値段：{{ item.price }}
    カテゴリー：{{ item.category }}
    俳優： -----

    {% endfor %}
PEP

ここでポイントになるのは、API Server　から受け取るJSONのレスポンスの分解方法です。 API Server のレスポンスはオブジェクト直下にvalueという配列要素があり、このレスポンスは「{{state.scenario_4.api_response.film_search.value}}」の形でアクセスできます。
設定イメージ：state.シナリオID.api_response.APIノード名.value
これを「FOR」での繰り返し処理で取得して、文章として表示する仕組みになっています。

PEP

これで設定は完了です。実際に動かしてみると、QuickBooks Online →API Server →　PEP　経由でデータを取得して表示していることがわかるかと思います。

CData API Server の無償版およびトライアル

CData API Server は、無償版および30日の無償トライアルがあります。是非、API Server ページ から製品をダウンロードしてお試しください。

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

詳細はこちら、または無料トライアルにお申し込みください：

CData API Server お問い合わせ

この記事の内容

関連記事