ローコードアプリ開発プラットフォームOutSystems でQuickBooks Online 連携アプリを作成

OutSystemsは、アプリケーションをUI 上で開発できるローコード開発プラットフォームです。この記事では、CData API Server を経由して OutSystems からQuickBooks Online に連携するアプリを作成する方法を説明します。

CData API Server は、QuickBooks Online のデータのクラウド to クラウドの仮想OData インターフェースを提供し、OutSystems からリアルタイムにQuickBooks Online のデータへ連携することができます。さらに、CData API Server は OpenAPI の定義ファイルを取得できるため、OutSystems で自動的にREST API Method を定義してスムーズにアプリ開発を行うことができます。

はじめに

---

API Server の設定

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

QuickBooks Online への接続

OutSystems から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. 接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
4. 併せて OutSystemsにAPIリクエストの仕様を取り込むためにAPI ページ（https://myserver/api.rst#oas）にある「Open API」のファイルを以下から保存しておきましょう。

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

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

OutSystems にCData API Server のコネクションを追加

続いてCData API Server への接続をOutSystems に追加します。OutSystems では RESTインターフェースを用いてCData API Server に接続します。

1. 「Logic」タブから「Integrations」→「REST」を右クリックし「Consume REST API…」を選択します。ここから外部のREST APIのメソッドをコールする処理・Logic を登録できます。

2. 今回は先程取得したOpen API Spec の情報を元に Logic を登録するので「ADD MULTIPLE METHODS」を選択し

3. 保存したOpen API Spec のファイルを「UPLOAD FILE」から選んで「ADD METHODS」をクリックして登録します。

4. すると以下のようにOpen API Spec のファイルを元に、メソッド一覧が出てくるので任意のメソッドを選択して「FINISH」をクリックします。

5. これで CData API Server へのLogic を登録できました。

6. Logic の登録が完了すると、併せて Data のタブのStructures にデータモデルが登録されます。

7. なお、これだけでは認証が通らないので、先程 CData API Server で登録したユーザーのID とToken をBasic Authentication のUsername とPassword に登録しましょう。

一覧画面を作成

それでは実際に CData API Server と連携した画面を作成していきましょう。

1. 「Interface」タブに移動して「Add Screen」をクリックします。

2. Screenのテンプレートは「Empty」で進めます。

3. Screenを登録したら、登録した対象のScreenから右クリックで「Fetch Data from Other Source」を選択します。これを先程登録したCData API Server の Logic と紐付けて、画面上からAPIをコールしてデータを表示します。

4. まず、利用するData Type を関連付けましょう。Out1のパラメータを選択して「Data Type」から CData API Server のAPI から生成されている Structures にあった一覧画面を取得するメソッドのレスポンスにあたるデータモデルを関連付けます。

5. そして、「Fetch Data from Other Source」のフローにCData API Server から全データを取得するメソッドをドラッグアンドドロップで配置します。

6. 取得したレスポンスは「Assign」機能を使って、Out1のパラメータに格納します。

7. これでデータ取得周りの処理が完成です。あとはUI 部品として「Table」をScreen 上に配置し

8. Out1で定義したレスポンスデータモデルをドラッグ・アンド・ドロップで配置します。

9. 「Sort Attribute」にある「value.」の部分は不要なので消してしまいましょう。

10. これだけで、CData API Server と連携した画面が作成できました。それでは画面中央上にある「Publish」ボタンをクリックして、動かしてみましょう。

11. 正常に起動すると、以下のような画面がブラウザで表示するので、登録したアカウントでログインします。

12. 一覧画面が表示されて、以下のようにCData API Server 経由で取得したQuickBooks Online のデータがきれいに表示されました。

クラウドアプリケーションからQuickBooks Online のデータにOData API アクセスを実現

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