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

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

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

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

Dropbox の仮想OData API エンドポイントを作成

まずCData Connect Server でデータソースへの接続およびOData API エンドポイント作成を行います。

1. CData Connect Server にログインして、Databases をクリックします。
2. 利用できるデータソースアイコンから"Dropbox" を選択します。
3. Dropbox に接続するために必要なプロパティを入力します。

   OAuth では認証するユーザーにブラウザでDropbox との通信を要求します。CData 製品は、以下のようにさまざまな方法でこれを容易にします。 ユーザー資格情報の接続プロパティを設定せずに接続できます。 接続すると、CData 製品はデフォルトブラウザでOAuth エンドポイントを開きます。ログインして、CData 製品にアクセス許可を与えます。CData 製品がOAuth プロセスを完了します。

   他のOAuth 認証フローについては、ヘルプドキュメントの「OAuth 認証の使用」を参照してください。

   なお、Dropbox Driver はDropbox のファイルの一覧表示やユーザー管理情報の取得用です。Dropbox に保管されているExcel、CSV、JSON などのファイル内のデータを読み込みたい場合には、Excel Driver、CSV Driver、JSON Driver をご利用ください。

4. Test Database をクリックします。
5. Permission -> Add をクリックして、新しいユーザーを追加し、適切な権限を指定します。
6. API タブをクリックして OData API エンドポイントが生成されていることを確認します。
7. 併せて OutSystemsにAPIリクエストの仕様を取り込むためにAPI タブにある「Open API」のファイルを以下から保存しておきましょう。

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

続いてCData Connect Server への接続をOutSystems に追加します。OutSystems では RESTインターフェースを用いてCData Connect 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 Connect Server へのLogic を登録できました。
6. Logic の登録が完了すると、併せて Data のタブのStructures にデータモデルが登録されます。
7. なお、これだけでは認証が通らないので、先程 CData Connect Server で登録したユーザーのID とToken をBasic Authentication のUsername とPassword に登録しましょう。

一覧画面を作成

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

1. 「Interface」タブに移動して「Add Screen」をクリックします。
2. Screenのテンプレートは「Empty」で進めます。
3. Screenを登録したら、登録した対象のScreenから右クリックで「Fetch Data from Other Source」を選択します。これを先程登録したCData Connect Server の Logic と紐付けて、画面上からAPIをコールしてデータを表示します。
4. まず、利用するData Type を関連付けましょう。Out1のパラメータを選択して「Data Type」から CData Connect Server のAPI から生成されている Structures にあった一覧画面を取得するメソッドのレスポンスにあたるデータモデルを関連付けます。
5. そして、「Fetch Data from Other Source」のフローにCData Connect Server から全データを取得するメソッドをドラッグアンドドロップで配置します。
6. 取得したレスポンスは「Assign」機能を使って、Out1のパラメータに格納します。
7. これでデータ取得周りの処理が完成です。あとはUI 部品として「Table」をScreen 上に配置し
8. Out1で定義したレスポンスデータモデルをドラッグ・アンド・ドロップで配置します。
9. 「Sort Attribute」にある「value.」の部分は不要なので消してしまいましょう。
10. これだけで、CData Connect Server と連携した画面が作成できました。それでは画面中央上にある「Publish」ボタンをクリックして、動かしてみましょう。
11. 正常に起動すると、以下のような画面がブラウザで表示するので、登録したアカウントでログインします。
12. 一覧画面が表示されて、以下のようにCData Connect Server 経由で取得したDropbox のデータがきれいに表示されました。

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

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