ノーコードアプリ開発ツールSAP Build Apps（AppGyver）でNetSuite 連携アプリを作成

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

SAP Build Apps（旧：AppGyver） は コーディングスキルを持たないユーザーでもWeb・モバイルアプリケーションを構築できるノーコード開発プラットフォームです。この記事では、CData API Server を経由して SAP Build Apps からNetSuite に連携するアプリを作成する方法を説明します。

CData API Server は、NetSuite のデータの仮想OData インターフェースを提供し、SAP Build Apps からリアルタイムにNetSuite のデータへ連携することができます。

CData API Server とは？

CData API Server は、以下のような特徴を持ったAPI 開発ツールです。

• あらゆるデータソースからAPI を生成：SQL Server、MySQL、Oracle、PostgreSQL、DB2 などのRDB、Excel、CSV、Google スプレッドシートなどCData の充実したコネクタライブラリを利用できます。
• 主要なデータ形式に対応：OData、REST、JSON、CSV / TSV など、主要な形式に対応しています。
• 一元管理でAPI を効率運用：単一の管理プラットフォーム上でAPI の更新、停止、共有が可能です。
• ノーコードでシンプルな設定：GUI ベースのインターフェースを使用して、複雑なコーディングなしでAPI を作成・セキュアに公開できます。

詳しくは、こちらの製品資料をご確認ください。

API Server の設定

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

デプロイ

API Server は内蔵のJetty サーバー上で動作します。Windows をお使いの場合は、スタンドアロンサーバーとして起動するか、IIS に組み込んで使用することが可能です。また、お使いのJava サーブレットコンテナにAPI Server のWAR ファイルを配置して実行することもできます。具体的なセットアップ方法については、こちらのヘルプドキュメントをご覧ください。

NetSuite への接続

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

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

5. Netsuite への接続

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

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

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

   1. Schema を設定して、接続に使用するAPI を指定。データを取得するだけの場合は、SuiteQL の使用をお勧めします。データの取得および変更が必要な場合は、SuiteTalk の使用をお勧めします。
   2. 使用する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 に設定されている場合にのみ使用できます。

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

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

Netsuite への接続

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

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

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

1. Schema を設定して、接続に使用するAPI を指定。データを取得するだけの場合は、SuiteQL の使用をお勧めします。データの取得および変更が必要な場合は、SuiteTalk の使用をお勧めします。
2. 使用する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 に設定されている場合にのみ使用できます。

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

API Server のユーザー設定

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

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

NetSuite 用のAPI エンドポイントの作成

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

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

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

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

SAP Build Apps でアプリを作成する

それではSAP Build Apps 側でアプリ開発を開始します。

1. 「CREATE NEW」をクリックし、

2. 任意の名前でアプリを作成します。

3. これで以下のようにアプリの開発画面が立ち上がります。

OData Integration の登録

アプリを作成したら、まず SAP Build Apps アプリでAPI 連携処理を行うための設定を追加します。

1. 「DATA」タブから「OData Integration」を追加しましょう。

2. 「Authentication Type」は「Basic authentication」を選択し、先ほど作成したCData API Server User のID とToken をそれぞれUsername・Passwordに入力します。 Base API URL はCData API Server のAPI タブにある「Base URL」で確認できます。これらを設定して「Verify URL」のボタンをクリックしましょう。

3. すると自動的にCData API Server に登録されているAPI データモデルを読み取って、SAP Build Apps が扱いやすい形で「list」、「retreve」、「create」、「update」、「delete」処理が生成されます。

4. 通常のREST API だと一つ一つ仕様を読み取って、登録していかなければいけないのですが、OData インターフェースに統一してくれるCData API Server を挟むことで、API の仕様を意識せず、SAP Build Apps で扱えるようになります。

変数の定義

それでは作成した OData Integration 機能を使ってアプリを作っていきます。とはいえ画面を作成する前に、API 経由で取得したデータを格納する変数を登録しておきましょう。

1. 画面デザインページから「VARIABLES」に移動します。

2. CData API Server から取得するデータ構造に合わせて変数を定義します。List とObject 構造の組み合わせで構成しましょう。

一覧画面の構成

変数を定義したら一覧画面を構成しましょう。

1. 今回はCard 形式の画面を作成しますが、カードを繰り返し表示するためにまず「Container」を配置します。

2. このContainer の中にCard を配置することで、カードが繰り返し表示される画面が構成できます。

3. Card を配置後、Properties タブから「Repeat with」で先ほど作成した変数をバインドします。

4. 「Data and Vaiables」を選択し

5. 先ほど作成しておいたList の変数をバインドします。

6. List の変数をバインドすると、Card にあるTitle やContent にもバインドできるようになります。

7. 「Data item in repeat」でそれぞれの変数をバインドしましょう。

Logic の記述

最後にAPI から取得したデータを変数に格納するLogic を記述していきます。

1. 画面下にあるLogic タブを開いて、ページを開いたときのLogic にAPI からデータを取得する「Get record collection」の処理を追加します。

2. 「Get record collection」の処理には認証情報を設定する必要があるので「Authentication」をクリックします。

3. 今回は固定値として設定するので「Obejct with properties」を選択し

4. 「Authentication Type」から「basic」を選択した上で、CData API Server のID とAPI Token をそれぞれ設定して保存します。

5. 次に取得したレコードを変数に格納します。「Set page variable」をLogic に配置しましょう。

6. 「Set page variable」を配置したら一旦Logic のコンポーネントをそれぞれつなげます。これで値を「Get record collection」から引き継げるようになります。

7. それでは「Set page variable」の値の設定を行いましょう。「Assigned value」のボタンをクリックし、

8. 「Mapping」を選択します。

9. デフォルトでは以下のような画面になっているので「no value」のボタンをクリックし、

10. 「Output value of another node」をクリック。

11. 前のLogic から引き継いだ「Get record collection」を選択します。

12. これでMapping が行えるようになります。

13. ドラッグアンドドロップで取得したデータと変数をマッピングしましょう。ここで予め変数をList とObject 形式で構成していたことが活きてきます。

実行してみる

それでは作成したアプリを実際に動かしてみましょう。

1. 「LAUNCH」タブから「Open App Preview Portal」をクリックします。

2. 以下のようにアプリ一覧画面が立ち上がるので「CDataSample」をクリックします。

3. すると、NetSuite からCData API Server 経由でデータを取得してきて、一覧表示を行った画面が表示されます。

このように、CData API Server を経由することで、API 側の複雑な仕様を意識せずにAPI 連携をしたアプリをSAP Build Apps で開発できます。他にも多くのデータソースに対応するCData API Server の詳細を、こちらからご覧ください。