Adalo アプリで使えるShort.io のデータ連携用のバックエンドAPI をノーコードで開発

杉本和也
杉本和也
リードエンジニア
ノーコードツールAdalo から Short.io のデータに接続するためのバックエンドAPI Server をCData API Server で構築



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

API Server の設定

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

Short.io への接続

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

  1. API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。 接続を追加
  2. 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「Short.io」を選択します。
  3. 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
    CData コネクタの追加方法はこちら >>
  4. それでは、Short.io への接続設定を行っていきましょう! 接続設定
  5. API キー認証の設定

    Short.io は API キー認証を使用します。API キーを取得するには、以下のステップで進めます:

    1. Short.io アカウントにログインします
    2. Settings > Integrations & API > API に移動します
    3. 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 リンクのクリック数とトラフィックの集計統計
  6. 接続情報の入力が完了したら、「保存およびテスト」をクリックします。

API キー認証の設定

Short.io は API キー認証を使用します。API キーを取得するには、以下のステップで進めます:

  1. Short.io アカウントにログインします
  2. Settings > Integrations & API > API に移動します
  3. 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」ページでユーザーを追加・設定できます。やってみましょう。

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

Short.io 用のAPI エンドポイントの作成

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

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

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 の設定方法 記事を参考にしてください。

Adalo でアプリを作成する

CData API Server 側の準備が完了したら、早速Adalo 側でアプリ開発を開始します。

  1. 「CREATE NEW APP」をクリックし
  2. 今回は「Desktop Web App」を作成します。
  3. template を最初に選ぶことができますが、今回は検証用なので何も無い「Blank」で作成しました。
  4. 最後にアプリ名とカラーリング設定を選んで、アプリの準備は完了です。

External Collections の登録

続いてCData API Server への接続をAdalo に追加します。Adalo では「Collection」という形でデータ構造を持ち、アプリのデータを管理することができるのですが、この「Collection」を外部のAPIとシームレスに連携した形で利用することができる「External Collections with APIs」という機能があります。この機能を用いてCData API Server に接続します。

  1. アプリを作成したら、まず Adalo アプリ内でデータを扱うための定義である「Collection」を登録します。Collection は Adalo 内部の独自DB のような「Database Collections」と、外部のAPI に対してシームレスにアクセスすることが可能な「External Collections」があります。今回は外部のAPI に対してアクセスを行うので「External Collections」で登録します。
  2. External Collections の登録画面では最初にコレクション名とAPI のベースとなるURL エンドポイントを指定します。任意のCollection 名とAPI Base URL に先程CData API Server で登録したShort.io の対象リソースに接続できるOData のエンドポイントを指定します。併せて認証情報として Header に「x-cdata-authtoken」の名前でCData API Server ユーザー登録時に生成されているTokenを指定します。
  3. 続いてAdalo から実行されるそれぞれのリクエストの関連付けを行います。通常のAPI であれば様々なチューニングが必要となる箇所ですが、Short.io ではほぼデフォルトの設定のままで進められます。一点だけ設定が必要な箇所として、Short.io からのレスポンスをレコード単位で識別するために「Get All」の設定にある「Results Key」に「value」を登録しておくことが挙げられます。これを設定したら「Next」をクリックしましょう。
  4. 最後にAPIの「RUN TEST」を行います。
  5. 「RUN TEST」をクリック後、最終的に以下のようにメッセージとレスポンスが表示されれば、External Collections の作成は完了です。

一覧画面の作成

それでは作成した External Collections を使ってアプリを作っていきましょう。

  1. まず一覧画面を表示するためにAdalo の画面右上の「+」ボタンをクリックして、「Simple List」をドラッグアンドドロップで画面に配置します。
  2. 以下のように配置できたら「What is this a list of?」で先程作成したExternal Collections の定義を紐付けます。
  3. 併せて「Title」と「Subtile」を取得するデータ項目に紐付けましょう。
  4. プレビューを実行し一覧画面に移動してみると、以下のようにShort.io のデータを取得できていました。

まとめと30日の無償評価版のご案内

このように、Short.io 内のデータをAdalo で利用することができるようになります。CData API Server は、30日の無償評価版があります。是非、お試しいただき、Adalo からのデータ参照を体感ください。

はじめる準備はできましたか?

詳細はこちら、または無料トライアルにお申し込みください:

CData API Server