Short.io のデータをノーコードモバイル開発のAppSheet で利用する方法
AppSheet は、インテリジェントなノーコードでのモバイルアプリケーションプラットフォームです。AppSheet では、データベースや OData への接続ができるため、CData の製品を組み合わせることで対応データソースを増やすことができます。この記事では CData API Server を使って、AppSheet でShort.io のデータ にデータ連携するモバイルアプリを開発する方法を説明します。
API Server の設定
以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなShort.io OData サービスを作成していきましょう。
Short.io への接続
AppSheet から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 の設定方法 記事を参考にしてください。
AppSheet でShort.io のOData サービスに登録
それでは、AppSheet からAPIServer への接続設定をしていきます。
- My account」から「Sources」タブをクリックします。
- 一番下まで下がると「+Data Source」がありますのでクリックします。
- AppSheet の対応データソースです。今回はOData を使います。
- APIServer への接続情報を入力します。
- OData Version: 4.0
- OData Service Root URL: API Server の以下のURL をセット
- Username: API Server で作成したユーザー名
- Password: API Server のアクセストークン
- SAP Gateway: Is not SAP Gateway
- Require Cross-Site Request Forgery(CSRF) Token: CSRD required
- 入力が完了したら、接続テストを行い、「Authorize Access」をクリックして保存します。
AppSheet でのShort.io のデータ 連携モバイルアプリ作成
- MyAppsタブから、「New app」をクリックします。
- 「Start with your own data」を選択します。
- アプリ名を設定します。入力後、「Next step: choose your data」をクリックします。
- 先ほど作成したものも含めて接続先が表示されます。私は事前に APIServer という名前に変更していましたが、変更していなければ odata-1 などの名前で表示されていると思います。
- ここでは APIServer で公開設定したテーブルだけが表示されます。モバイルアプリで使用するテーブルを選択します。
- テーブル選択を行うとアプリ作成画面が表示されます。選択したデータソースをもとに自動的に右側にアプリが作成されます。
このように Short.io 内のデータを簡単にAppSheet で作成するモバイルアプリで使用することができるようになります。
CData API Server の無償版およびトライアル
CData API Server は、無償版および30日の無償トライアルがあります。是非、API Server ページ から製品をダウンロードしてお試しください。