Bubble で使えるSFTP のデータ連携用のバックエンドAPI をノーコードで開発

杉本和也
リードエンジニア

ノーコードツールBubble から SFTP のデータに接続するためのバックエンドAPI Server をCData API Server で構築

CData API Server を使って、Bubble から SFTP に接続してデータを取得する方法を説明します。

API Server の設定

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

SFTP への接続

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

API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「SFTP」を選択します。
事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >>
それでは、SFTP への接続設定を行っていきましょう！
FTP は、SFTP プロトコルを使用してSFTP サーバーとの間のファイル転送を行います。接続するにはRemoteHost を指定します。FTP はUser、Password、および公開鍵認証（SSHClientCert）を使用します。 SSHAuthMode を選択し、選択に基づいて接続値を指定します。

次の接続プロパティを設定し、ファイルシステムのリレーショナルビューをコントロールします。
- RemotePath: 現在の作業ディレクトリに設定。
- TableDepth: ビューとしてレポートするサブフォルダの深度を制御するために設定。
- FileRetrievalDepth: ファイルを再帰的に取得し、Root テーブルにリストするために設定。
ストアドプロシージャは、ファイル、のダウンロード、アップロード、およびプロトコルコマンドの送信に利用できます。SQL を使用してサーバーと対話する方法の詳細については、ヘルプドキュメントの「データモデル」を参照してください。
接続情報の入力が完了したら、「保存およびテスト」をクリックします。

FTP は、SFTP プロトコルを使用してSFTP サーバーとの間のファイル転送を行います。接続するにはRemoteHost を指定します。FTP はUser、Password、および公開鍵認証（SSHClientCert）を使用します。 SSHAuthMode を選択し、選択に基づいて接続値を指定します。

次の接続プロパティを設定し、ファイルシステムのリレーショナルビューをコントロールします。

RemotePath: 現在の作業ディレクトリに設定。
TableDepth: ビューとしてレポートするサブフォルダの深度を制御するために設定。
FileRetrievalDepth: ファイルを再帰的に取得し、Root テーブルにリストするために設定。

ストアドプロシージャは、ファイル、のダウンロード、アップロード、およびプロトコルコマンドの送信に利用できます。SQL を使用してサーバーと対話する方法の詳細については、ヘルプドキュメントの「データモデル」を参照してください。

API Server のユーザー設定

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

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

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

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

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

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

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

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

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

SFTP のデータに接続したアプリを作成

OData エンドポイントをAPI Server に追加したら、SFTP のデータへのライブ接続が可能なアプリをBubble で作成できます。

Bubble API Connector を設定

まずは、Bubble からCData API Server にアクセスするためのAPI Connector を設定します。

アプリ内で、Plugins タブをクリックして Add plugins をクリックします。
「API Connector」を検索して「Install」をクリックします。
インストール後、「Add another API」ボタンをクリックしてAPI を設定します。
- API に名前を設定します。
- Authentication を「HTTP Basic Auth」に設定します。
- Username をAPI Server のユーザーに設定します（user@mydomain.com）。
- Password を上記のユーザーのPAT に設定します。
- API Call を展開して、「GET」コマンドを選択してURL を先ほど設定したOData エンドポイントに設定します。
「Initialize call」ボタンをクリックしてレスポンスのデータ型を必要に応じて調整します。
必要な変更を加えた後、「SAVE」をクリックします。