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

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

Retool はローコードでWebベースの業務アプリケーションを構築できるクラウドサービスです。この記事では、CData Connect Server を経由して Retool からAmazon S3 に連携するアプリを作成する方法を説明します。

CData Connect Server は、Amazon S3 データのクラウド to クラウドの仮想OData インターフェースを提供し、Retool からリアルタイムにAmazon S3 データへ連携することができます。

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

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

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

   Amazon S3 リクエストを認可するには、管理者アカウントまたはカスタム権限を持つIAM ユーザーの認証情報を入力します。AccessKey をアクセスキーID に設定します。SecretKey をシークレットアクセスキーに設定します。

   Note: AWS アカウント管理者として接続できますが、AWS サービスにアクセスするにはIAM ユーザー認証情報を使用することをお勧めします。

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

   アクセスキーの取得

   IAM ユーザーの資格情報を取得するには：

   1. IAM コンソールにサインインします。
   2. ナビゲーションペインで「ユーザー」を選択します。
   3. ユーザーのアクセスキーを作成または管理するには、ユーザーを選択してから「セキュリティ認証情報」タブを選択します。

   AWS ルートアカウントの資格情報を取得するには：

   1. ルートアカウントの資格情報を使用してAWS 管理コンソールにサインインします。
   2. アカウント名または番号を選択し、表示されたメニューで「My Security Credentials」を選択します。
   3. 「Continue to Security Credentials」をクリックし、「Access Keys」セクションを展開して、ルートアカウントのアクセスキーを管理または作成します。

   AWS ロールとして認証

   多くの場合、認証にはAWS ルートユーザーのダイレクトなセキュリティ認証情報ではなく、IAM ロールを使用することをお勧めします。RoleARN を指定することでAWS ロールを代わりに使用できます。これにより、CData 製品は指定されたロールの資格情報を取得しようと試みます。

   （すでにEC2 インスタンスなどで接続されているのではなく）AWS に接続している場合は、ロールを引き受けるIAM ユーザーのAccessKey とSecretKey を追加で指定する必要があります。AWS ルートユーザーのAccessKey および SecretKey を指定する場合、ロールは使用できません。

   SSO 認証

   SSO 認証を必要とするユーザーおよびロールには、RoleARN およびPrincipalArn 接続プロパティを指定してください。各Identity Provider に固有のSSOProperties を指定し、AccessKey とSecretKey を空のままにする必要があります。これにより、CData 製品は一時的な認証資格情報を取得するために、リクエストでSSO 認証情報を送信します。

4. Test Database をクリックします。
5. Permission -> Add をクリックして、新しいユーザーを追加し、適切な権限を指定します。
6. API タブをクリックして OData API エンドポイントが生成されていることを確認します。

Resource の登録

続いてRetool 側の手順を進めていきます。Retool ではまず、構成したAPI にアクセスするためのリソース情報を登録します。

1. Retool にログインし、「Resouces」から「Create new」をクリックします。
2. 接続できるサービスの一覧が表示されるので「REST API」を選択します。
3. REST APIの設定画面では以下の通り必要な情報を入力します。Base URLには事前に作成したAPI のリソースエンドポイントを指定します。Headers には生成したユーザーの認証トークンを「x-cdata-authtoken」ヘッダーとして指定します。
4. リソースを作成後、アプリの作成確認ダイアログが出てくるので、今回はこれで作成してしまいます。（もちろんテンプレートなどを使っても構いません。）
5. 任意の名称を指定してください。

一覧画面の作成

リソースの登録が完了したら一覧画面を作成しましょう。

1. まず、先程登録したAPIのコネクションを使って、データを取得するための「Query」を定義します。すでに登録されているQueryの名前を変更し内部のAPIを定義を調整します。
2. デフォルトで Action Type、つまりAPIリクエストのメソッドが「GET」なので、このままでもデータは取得できます。ただ、初期状態ではすべての項目を取得してしまうので、API Serverがサポートするクエリパラメータを使って、取得項目やフィルター条件等を指定します。
3. URL parmeters を記述したら、設定を保存して実行してみましょう。以下のようにデータが取得できればOKです。
4. あとはこのデータを画面に表示するための「Table」UIコンポーネントを画面に配置します。
5. デフォルトえはJSON形式のサンプルデータが表示されているので、これを変更します。
6. 先程のクエリ名と対象のオブジェクト名を「{{QueryName.data.value}}」といった形で指定するだけでOKです。これだけで簡単に一覧画面が構成できました。
7. 作成した画面はプレビューモードで動作確認できます。

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