製品をチェック

製品の詳細・30日間の無償トライアルはこちら

CData API Server

お困りの点はございませんか？

類似の事例やソリューションを探す

データ連携のスペシャリストにご相談ください

NetSuite 連携について相談する

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

AI アシスタントPEP から NetSuite のデータに連携し、チャットボットでリアルタイムNetSuite のデータを使う方法

杉本和也
リードエンジニア
最終更新日：2022-06-24

この記事で実現できるNetSuite 連携のシナリオ

CData

こんにちは！リードエンジニアの杉本です。

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

API Server の設定

次のステップに従い、セキュアな REST API サービスを立ち上げます

デプロイ

API Server はサーバー上で稼働します。Windows 版は、製品に組み込まれているスタンドアロンのサーバーかIIS に配置して稼働させることができます。Java 版では、Java servlet コンテナにAPI Server のWAR ファイルを配置します。デプロイの詳細は製品ヘルプを参照してください。API Server を Microsoft Azure、 Amazon EC2、Heroku にデプロイする方法はKB に記事があります。

NetSuite への接続

API Server の管理コンソールで［設定］→［接続］から新しい接続を追加してNetSuite を追加します。

NetSuite のアイコンがデフォルトのAPI Server の接続先にない場合には、API Server がJava 版の場合はJDBC Drivers、API Server がWindows 版の場合はADO.NET Data ProvidersからNetSuite ドライバーをAPI Server と同じマシンにインストールして、API Server を再起動します。

NetSuite への接続に必要な認証情報を入力します。接続のテストを行い、接続を確認して、設定を保存します。

Netsuite への接続

NetSuite は現在、2つの異なるAPI を提供しています。

SuiteTalk はNetSuite との通信に使用する、SOAP ベースのより古いサービスです。多くのエンティティを幅広くサポートし、INSERT / UPDATE / DELETE を完全にサポートします。しかしデータの抽出用ツールは低機能で、SELECT 時のパフォーマンスは極めて低いです。テーブルを結合するよい方法もありません。データのグループ化および集計はこのAPI からは利用できず、そのためこれらの操作をサポートするには、すべてをクライアントサイドで実行しなければなりません。
SuiteQL は新しいAPI です。サービスとのSQL ライクな通信方法を実現するため、JOIN の機能はより豊富になり、GROUP BY や集計機能もサポートします。加えて、抽出したいカラムだけを取得する機能も完全にサポートします。そのため、データを抽出する際のパフォーマンスがSuiteTalk より大幅に向上しています。ただし、サポートされるのはデータの抽出のみです。

NetSuite に接続するには、以下を行う必要があります。

Schema を設定して、接続に使用するAPI を指定。データを取得するだけの場合は、SuiteQL の使用をお勧めします。データの取得および変更が必要な場合は、SuiteTalk の使用をお勧めします。
使用するAPI に適した接続オプションを設定します。（それぞれのAPI で利用可能な接続オプションが異なります。ヘルプドキュメントの「許可の設定」を参照してください。）

Netsuite への認証

SuiteTalk またはSuiteQL

NetSuite は3つの形式のOAuth 認証を提供します。

トークンベース認証（TBA）は、基本的にOAuth 1.0 で、OAuthAccessToken とOAuthAccessTokenSecret を実行時ではなくNetSuite UI 内で作成します。 TBA は、2020.2 以降のSuiteTalk およびSuiteQL の両方で利用可能です。
OAuth 2.0 認証は、SuiteQL でのみ利用できます。OAuth 2.0 認証を強制するには、次のいずれかを実行します。
- OAuthVersion を使用するAPI に明示的に設定、または
- Schema をSuiteQL に設定
OAuth JWT 認証は、OAuth 2.0 クライアント認証フローであり、クライアント認証情報を含むJWT を使用してNetSuite データへのアクセスを要求します。この認証方法は、Schema がSuiteQL に設定されている場合にのみ使用できます。

認証方法の詳細はヘルプドキュメントの「はじめに」を参照してください。

接続を確立後、［設定］→［リソース］の画面でからREST API として公開するエンティティを選択します。

API Server のユーザー設定

［設定］→［ユーザー］からAPI にアクセスできるユーザーの認証設定を行います。API Server はトークンでの認証を行うことができます。 IP アドレスでAPI へのアクセスを制限することも可能です。デフォルトではローカルマシンからのアクセスのみが許可されています。SSL の設定も可能です。

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

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

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

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

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

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

「会話編集」→「シナリオ」に移動し、新しいシナリオを作成します。

シナリオ名を入力します。この例では、条件はSlack Homeを　選択しています。

「新規作成」ボタンをクリックすると、以下のようなシナリオエディタ画面に移動します。これでシナリオを作成する準備ができました。

NetSuite のAPI の接続箇所の設定

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

最初に検索したい文字列を受け取るための対話ノードを配置して、以下のように構成します。

ポイントは分岐条件で「以下のすべての会話」、発言内容の記憶で「film_name」として、会話した内容を変数に保存することです。

対話ノードを配置したら、APIノードを追加して、対話ノードから接続していきます。

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のトークン」を指定

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

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

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

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

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

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

    {% endfor %}

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

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

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

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

トライアル・お問い合わせ

30日間無償トライアルで、CData のリアルタイムデータ連携をフルにお試しいただけます。記事や製品についてのご質問があればお気軽にお問い合わせください。

無償トライアルへ

お問い合わせ

ソリューション

サポート

ブログへ →

ナレッジベース