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

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

CData API Server を使ってShort.io のデータの仮想OData API エンドポイントを作成して、OutSystems からShort.io のデータを使ったアプリを作成する方法。

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

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

API Server の設定

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

Short.io への接続

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

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

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」ページに移動し、「テーブルを追加」をクリックします。
アクセスしたい接続を選択し、次へをクリックします。
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
併せて OutSystemsにAPIリクエストの仕様を取り込むためにAPI ページ（https://myserver/api.rst#oas）にある「Open API」のファイルを以下から保存しておきましょう。

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

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

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

続いてCData API Server への接続をOutSystems に追加します。OutSystems では RESTインターフェースを用いてCData API Server に接続します。

「Logic」タブから「Integrations」→「REST」を右クリックし「Consume REST API…」を選択します。ここから外部のREST APIのメソッドをコールする処理・Logic を登録できます。

今回は先程取得したOpen API Spec の情報を元に Logic を登録するので「ADD MULTIPLE METHODS」を選択し

保存したOpen API Spec のファイルを「UPLOAD FILE」から選んで「ADD METHODS」をクリックして登録します。

すると以下のようにOpen API Spec のファイルを元に、メソッド一覧が出てくるので任意のメソッドを選択して「FINISH」をクリックします。

これで CData API Server へのLogic を登録できました。

Logic の登録が完了すると、併せて Data のタブのStructures にデータモデルが登録されます。

なお、これだけでは認証が通らないので、先程 CData API Server で登録したユーザーのID とToken をBasic Authentication のUsername とPassword に登録しましょう。

一覧画面を作成

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

「Interface」タブに移動して「Add Screen」をクリックします。

Screenのテンプレートは「Empty」で進めます。

Screenを登録したら、登録した対象のScreenから右クリックで「Fetch Data from Other Source」を選択します。これを先程登録したCData API Server の Logic と紐付けて、画面上からAPIをコールしてデータを表示します。

まず、利用するData Type を関連付けましょう。Out1のパラメータを選択して「Data Type」から CData API Server のAPI から生成されている Structures にあった一覧画面を取得するメソッドのレスポンスにあたるデータモデルを関連付けます。

そして、「Fetch Data from Other Source」のフローにCData API Server から全データを取得するメソッドをドラッグアンドドロップで配置します。

取得したレスポンスは「Assign」機能を使って、Out1のパラメータに格納します。

これでデータ取得周りの処理が完成です。あとはUI 部品として「Table」をScreen 上に配置し

Out1で定義したレスポンスデータモデルをドラッグ・アンド・ドロップで配置します。

「Sort Attribute」にある「value.」の部分は不要なので消してしまいましょう。

これだけで、CData API Server と連携した画面が作成できました。それでは画面中央上にある「Publish」ボタンをクリックして、動かしてみましょう。

正常に起動すると、以下のような画面がブラウザで表示するので、登録したアカウントでログインします。

一覧画面が表示されて、以下のようにCData API Server 経由で取得したShort.io のデータがきれいに表示されました。

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

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

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

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

CData API Server

CData は、AI を本番環境で機能させるデータレイヤーです。数百の主要エンタープライズソースへのライブコネクティビティとレプリケーション、セマンティックコンテキスト、組み込みガバナンスを提供。Databricks、Microsoft、Google、Palantir をはじめ、世界中の 10,000 以上のお客様の AI を支えています。

お問い合わせ

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

API Server の設定