Bubble で使えるShort.io のデータ連携用のバックエンドAPI をノーコードで開発
CData API Server を使って、Bubble から Short.io に接続してデータを取得する方法を説明します。
API Server の設定
以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなShort.io OData サービスを作成していきましょう。
Short.io への接続
Bubble からShort.io のデータを操作するには、まずShort.io への接続を作成・設定します。
- API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
- 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「Short.io」を選択します。
- 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >> - それでは、Short.io への接続設定を行っていきましょう!
-
API キー認証の設定
Short.io は API キー認証を使用します。API キーを取得するには、以下のステップで進めます:
- Short.io アカウントにログインします
- Settings > Integrations & API > API に移動します
- Create API Key をクリックして API キーをコピーします
API キーを取得したら、接続を確立できます:
- AuthScheme:APIKey に設定します。
- APIKey:Settings > Integrations & API > API から取得した Short.io の API キーに設定します。
接続文字列の例:
Profile=C:\profiles\ShortIo.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';
利用可能なテーブル
Short.io プロファイルでは、以下のテーブルにアクセスできます:
- Domains - 認証済みアカウントに関連付けられた Short.io ドメイン
- Links - ドメインの短縮リンク
- LinkExpand - ドメインとパスから短縮リンクを展開
- LinksByOriginalUrl - 指定した元の宛先 URL に一致する複数の短縮リンクを取得
- Folders - 特定のドメイン内のリンクフォルダー
- LinkPermissions - ドメイン内の特定のリンクの権限レコード
- CountryTargeting - 特定の短縮リンクの国別リダイレクトターゲティングルール
- RegionTargeting - 特定の短縮リンクの地域別リダイレクトターゲティングルール
- Regions - 指定した国コードに対する利用可能な地域/州の一覧
- DomainStatistics - Short.io ドメインのクリック数とトラフィックの集計統計
- LinkStatistics - 特定の Short.io リンクのクリック数とトラフィックの集計統計
- 接続情報の入力が完了したら、「保存およびテスト」をクリックします。
API キー認証の設定
Short.io は API キー認証を使用します。API キーを取得するには、以下のステップで進めます:
- Short.io アカウントにログインします
- Settings > Integrations & API > API に移動します
- Create API Key をクリックして API キーをコピーします
API キーを取得したら、接続を確立できます:
- AuthScheme:APIKey に設定します。
- APIKey:Settings > Integrations & API > API から取得した Short.io の API キーに設定します。
接続文字列の例:
Profile=C:\profiles\ShortIo.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';
利用可能なテーブル
Short.io プロファイルでは、以下のテーブルにアクセスできます:
- Domains - 認証済みアカウントに関連付けられた Short.io ドメイン
- Links - ドメインの短縮リンク
- LinkExpand - ドメインとパスから短縮リンクを展開
- LinksByOriginalUrl - 指定した元の宛先 URL に一致する複数の短縮リンクを取得
- Folders - 特定のドメイン内のリンクフォルダー
- LinkPermissions - ドメイン内の特定のリンクの権限レコード
- CountryTargeting - 特定の短縮リンクの国別リダイレクトターゲティングルール
- RegionTargeting - 特定の短縮リンクの地域別リダイレクトターゲティングルール
- Regions - 指定した国コードに対する利用可能な地域/州の一覧
- DomainStatistics - Short.io ドメインのクリック数とトラフィックの集計統計
- LinkStatistics - 特定の Short.io リンクのクリック数とトラフィックの集計統計
API Server のユーザー設定
次に、API Server 経由でShort.io にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。
- 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
-
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
-
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。
Short.io 用のAPI エンドポイントの作成
ユーザーを作成したら、Short.io のデータ用のAPI エンドポイントを作成していきます。
-
まず、「API」ページに移動し、
「 テーブルを追加」をクリックします。
-
アクセスしたい接続を選択し、次へをクリックします。
-
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
OData のエンドポイントを取得
以上でShort.io への接続を設定してユーザーを作成し、API Server でShort.io データのAPI を追加しました。これで、OData 形式のShort.io データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。
オンプレミスDB やファイルからのAPI Server 使用(オプション)
オンプレミスRDB やExcel/CSV などのファイルのデータを使用する場合には、API Server のCloug Gateway / SSH ポートフォワーディングが便利です。是非、Cloud Gatway の設定方法 記事を参考にしてください。
Short.io のデータに接続したアプリを作成
OData エンドポイントをAPI Server に追加したら、Short.io のデータへのライブ接続が可能なアプリを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 のユーザーに設定します([email protected])。
- Password を上記のユーザーのPAT に設定します。
- API Call を展開して、「GET」コマンドを選択してURL を先ほど設定したOData エンドポイントに設定します。
- 「Initialize call」ボタンをクリックしてレスポンスのデータ型を必要に応じて調整します。
- 必要な変更を加えた後、「SAVE」をクリックします。
App UI の設定
API Connector を設定したら、Bubble アプリでShort.io のデータを取得できます。本記事では、Excel ライクなテーブルを表示できるUI コンポーネントでデータをリクエストします。
- Plugin タブで、「Excel-like HandsonTable」をインストールします。
- Design タブで、「Excel Table」をワークスペースに追加します。
- Excel Table のData source で、「Get data from an external API」を選択します。
- Type of content を「API Call value」に設定します。
- Data source を"API Server - <API Call の値>"(またはこれと同等な値)に設定します。
- 「Preview」をクリックしてShort.io からデータが取得できたことを確認します。
この時点で、バックエンドAPI を設定する手間なくShort.io のデータへのライブ接続を持つアプリケーションを開発できます。
クラウドアプリケーションからShort.io のデータへのライブ接続
Bubble からShort.io のリアルタイムデータに直接接続できるようになりました。これで、Short.io のデータを複製せずにより多くの接続とアプリを作成できます。
まとめと30日の無償評価版のご案内
このように Short.io 内のデータをBubble で利用することができるようになります。CData API Server は、30日の無償評価版があります。是非、お試しいただき、Bubble からのデータ参照を体感ください。