IICS CAI を使って、APIのレスポンスをファイル出力してみる

この記事は インフォマティカ Advent Calendar 2022 Day 10 の記事として書かれています。

はじめに

本記事では、Informatica Intelligent Cloud Services の アプリケーション統合/Cloud Application Integration を使ったAPI連携処理の作成についてご紹介します。

例えば、飲み会などのお店情報が某大手サイトのURLで送られてきた場合、そのサイトから場所を確認するとGoogle Mapが使用されていることがあるのではないでしょうか？
これは、Google社が地図情報を取得するためのAPIを公開しており、そのサイトでは、APIを介して地図情報を取得し、掲載しているのです。

また、アカウントを作成する際、郵便番号を入力し、横にある「住所検索」のようなボタンをクリックすると、住所が自動入力される機能を使用したことがあるのではないでしょうか？
これも、外部の郵便番号から住所検索する機能がAPIで公開されており、同様にAPIを介してデータを取得し、自動入力されている場合が多いです。

このように、API連携処理は、日常生活のあらゆるところで利用されています。

今回使用する Cloud Application Integration とは、そんなAPIを介したデータ連携をGUIベースで作成することが出来る機能となります。

今回作成するAPI連携処理について

本記事では、政府統計の総合窓口であるe-Statにて提供されているオープンデータを取得するAPIを使用します。
ここでは、令和2年の国勢調査のデータをAPIを介して取得してみます。
そして、JSONファイルとして、SecureAgentをインストールしたサーバのローカルディレクトリに出力する処理を作成します。

それでは、作成していきましょう。

１．ユーザ登録

政府統計の総合窓口であるe-StatでAPIを使用するためには、ユーザ登録が必要となりますので、登録を行いました。
ユーザ登録方法やAPIの仕様などについては、下記URLをご参照ください。
https://www.e-stat.go.jp/api/

今回は、以下の統計データを取得してみます。

２．プロセスの作成

2-1.サービスコネクタの作成

まず、サービスコネクタを作成します。
サービスコネクタは、任意のWebサービスを呼び出すための接続情報を設定するアセットとなります。

2-2-1.新規作成

アプリケーション統合/Cloud Application Integrationの[新規]をクリック後、[サービスコネクタ - フォームを使用したサービスコネクタ]を選択し、[作成]を押下します。

2-2-2.[定義]タブの設定

[定義]タブでは、アセットの名前や説明、Webサービスに接続するために必要なプロパティを入力します。
接続プロパティには、データセット情報のAPIリクエストURLを設定しました。

2-2-3.[プロセスオブジェクト]タブの設定

[プロセスオブジェクト]タブでは、データをグループ化し、構造化オブジェクトを作成できます。
今回はプロセスオブジェクト名とフィールド名に次の設定を行いました。

2-2-4.[アクション]タブの設定

[アクション]タブではサービスに対するアクションを設定します。
今回は次の設定を行いました。

• [アクション]タブ
  
• [入力]タブ
  
• [バインディング]タブ
  
• [出力]タブ
  

2-2.アプリケーション接続の作成

次に、アプリケーション接続を作成します。
アプリケーション接続は、ソースまたはターゲットの接続情報を設定するアセットとなります。
今回はソースがe-Stat、ターゲットがローカルディレクトリとして、次の設定を行いました。

• ソース：e-Stat
  下記を設定します。
  タイプ：「2-1」で作成したサービスコネクタを指定
  接続プロパティ：「Host Name」にAPIリクエストURLを設定
  
• ターゲット：SecureAgentをインストールしたサーバのローカルディレクトリ
  下記を設定します。
  ● [プロパティ]タブ
  タイプ：「File」を指定
  
  ● [イベントターゲット]タブ
  出力先として使用するため、[イベントターゲット]タブを選択します。
  ①「Add Event Target」から「FileWriter」を選択
  ②「プロパティ」の「Directory」に出力先ディレクトリを指定
  

2-3.プロセスの作成

そして、プロセスを作成します。
APIを介してリクエストを送信してレスポンスを受信し、その結果をJSONファイルとして出力するプロセスを作成します。

• 全体像
  

2-3-1.開始ステップ

• [全般]プロパティ
  名前を入力します。
  
• [入力フィールド]プロパティ
  APIリクエストのパラメータとして設定する値を受け取るためのフィールドを設定します。
  
• [出力フィールド]プロパティ
  e-Statから取得した値をクライアントへ返却するためのフィールドを設定します。
  

2-3-2.サービスステップ(統計データを取得)

• [全般]プロパティ
  名前を入力します。
  
• [サービス]プロパティ
  APIリクエストをするために、e-Statへの接続情報を設定したアプリケーション接続を指定します。
  
• [入力フィールド]プロパティ
  APIの各入力フィールドに対して、開始ステップの入力フィールドをマッピングします。
  

2-3-3.割り当てステップ

• [全般]プロパティ
  名前を入力します。
  
• [割り当て]プロパティ
  受信したレスポンスを開始ステップの出力フィールドにマッピングします。
  

2-3-4.サービスステップ(ファイル出力)

• [全般]プロパティ
  名前を入力します。
  
• [サービス]プロパティ
  ファイル出力するために、SecureAgentをインストールしたサーバのローカルディレクトリへの接続情報を設定したアプリケーション接続を指定します。
  
• [入力フィールド]プロパティ
  計算式で出力内容について設定します。
  

計算式の例

<FileWriteTask>
<fileName>TEST.json</fileName>               --- ファイル名
<format>JSON</format>                        --- フォーマット
<content>application/json</content>
   <objectName>response_value</objectName>
   <object>{$output.response_value  }        --- ファイルに出力する内容
   </object>
</FileWriteTask>

ここまで設定できたら、[保存]して[パブリッシュ]します。

３．実行結果

それでは、実行してみましょう。
[プロパティの詳細]からサービスURLをコピーします。


Postmanを使って、リクエストします。
コピーしたサービスURLとAPIリクエストのパラメータ値を設定して、送信します。

実行完了後に確認すると、指定したディレクトリに出力されています。

また、中を確認すると、取得したデータが出力されています。

４．最後に

今回は、サンプルとして簡単なAPI連携処理を作成しましたが、いかがでしたでしょうか？
今後も拡大していくAPIを介したデータ連携について、IICS CAI(Cloud Application Integration)を使ってぜひお試しください。

参考サイト

• IICS CAI(Cloud Application Integration)のマニュアル
  https://docs.informatica.com/integration-cloud/cloud-application-integration/current-version.html

• 政府統計の総合窓口(e-Stat)
  https://www.e-stat.go.jp/