Node.js からShort.io のデータをクエリ

CData API Server とADO.NET Provider for API(もしくは240+ の他のADO.NET Providers)を使って、Short.io をOData エンドポイントして公開し、Node.js からシンプルなHTTP リクエストでクエリを実現します。本記事ではAPI Server を使ってJSON でフォーマットされたShort.io のデータをNode.js でリクエストする方法を説明します。

API Server の設定

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

Short.io への接続

NodeJS から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 のエンドポイントを表示およびコピーできます。

Node.js からShort.io OData フィードを利用

OData フィードはNode.js で簡単に使用できます。Node.js のHTTP クライアントを使用して、API Server のOData エンドポイントからJSON 形式のデータをリクエストしていきましょう。リクエストを行った後、レスポンスの本文を作成し、JSON.parse() 関数を呼び出してレコードに解析できます。

以下のコードはDomains データに対して認証されたリクエストを行います。 以下のURL の例では、 カラムの値が のレコードを検索する単純なフィルターを適用しています。

var http = require('http');
http.get({
  protocol: "http:",
  hostname:"MyServer.com",
  port:MyPort,
  path: "/api.rsc/Domains?$filter=" + encodeURIComponent(" eq ''"),
  auth:'MyUser:MyAuthtoken'
},
function(res) {
  var body = '';
  res.on('data', function(chunk) {
    body += chunk;
  });
  res.on('end', function() {
    console.log(body);
    var jsonData = JSON.parse(body);
  });
}).on('error', function(e) {
  console.log("Error: ", e);
});