気象情報APIを使ってアプリを作ってみた -Integration Service編-
#目次
- 概要
- Integration Serviceを作成しよう
- まとめ
#概要
Kony PlatformでYahoo!JAPANデベロッパーネットワークの気象情報APIを使った降水の有無をお知らせしてくれるWebアプリケーションを作っていきたいと思います。
本記事ではIntegration Serviceの記事を読んで、__Integration Service__を作成していきます。あらかじめVisualizerにてアプリケーションの画面を作っておいた方が使用するパラメータを決めやすくおすすめです。
では早速作っていきましょう。
#Integration Serviceを作成しよう
-
Kony Fabric Consoleにログイン後、「Apps」で[ADD NEW]をクリックすると新しい__Fabric Apps__を作成します。
作成したFabric Appsには最初は名前が入っていません。下図のようにアプリケーション名の右隣の鉛筆マークで編集することができるので、そこで自分の作成するアプリケーションの名前に編集しましょう(今回は「WeatherCheck」という名前にしました)。
-
作成したFabric Appsをクリックし、__Configure Services__タブでIntegrationを選択します。下図の「＋」ボタンをクリックし[Add New Service]をクリックする、もしくは[ADD NEW]から[CONFIGURE NEW]をクリックすることで新たなサービスを作成します。
-
サービスを定義していきます。Nameなど必要な値を適切に入力していきます(使いたいService Typeによって入力項目が異なります。今回は使用するAPIでJSON形式が利用でき、JSONを選択したのでNama・ServiceType・PathExpression・Ver・Base URL・Web Service Authentication・IdentityServiceの入力が必要です)。
ここで入力必須の項目に__Base URL__があります。
このBase URLには__使いたいAPIやサービス__のURLを入力すればOKです。
今回使用するのはYahoo!JAPANディベロッパーネットワークの気象情報APIですので下記のURLを入力します。
https://developer.yahoo.co.jp/webapi/map/openlocalplatform/v1/weather.html -
作成したIntegration Serviceに[ADD OPERATION]ボタンを押してオペレーションを作成します。こちらもNameなど必要な値を入力していきます。
上部の項目(Target URLのEnter suffixは後述するので一旦置いておいてそれ以外の項目)に値が入力できたらリクエストとレスポンスを入力していきます。 -
リクエストとレスポンスを入力していきます。
使用するAPIのリクエストとレスポンスを入力します。
リクエストの方は比較的わかりやすく、APIを使う上で必要なパラメーターを入力していきます。[Add Parameter]ボタンを押すことでパラメーターを追加することができます。
Data Typeに関して、今回はすべてStringですが必要に応じて変更します。
レスポンスの入力は手入力で行うことも出来ますがやや難しいところがあります。特に__PATH__の入力がわかりにくいです。
なのでリクエストパラメータを設定した後、下図右下の[Select an Environment]で環境を選択し[SAVE AND FETCH RESPONSE]をクリックしてください。
リクエストパラーメータが正しく、疎通が成功すると下図のように__Request Payload__・Backend Response・__Output Result__が得られます。
また__Backend Response__で取得したいレスポンスにカーソルを合わせると下図のように「Create Response」
と出てくるので、それをクリックするとレスポンスの設定が可能です。
DATA TYPEについては今回の解説の趣旨からは逸れるので深くは言及しませんが、DATA TYPEで「collection」を選択することで返還されるJSONのフィールド内の配列を表すことができます。
「$.●●.▲▲[*]」とPATHに記載し、DATA TYPEを「collection」にすると、「COLLECTION ID」で▲▲を指定することで▲▲の配列内のフィールドをレスポンスのパラーメータとして加えることができます。
- Target URLのEnter suffixについて
手順5までで一通りのサービスの作成は完了ですが、この状態で[Select an Environment]で環境を選択し[SAVE AND FETCH RESPONSE]をクリックしてテストを行なってもおそらくエラーで返ってくると思います。
私の場合、この時のエラーのステータスコードは401でした。有効な認証資格が不足しているというものです。
今回利用した気象情報APIを利用するにはappidが必要であるため、Target URLのEnter suffixに下図のように値を入力してみてください。
おそらくテストにて正常に値が返ってくると思います。
またバックエンドレスポンスは返って来るけれど、Output ResultがJSONになってくれず、「Malformed JSON Response」というエラーメッセージが出て上手くいかない時は、リクエストパラメータにoutputを加えてDATA TYPEで「json」を指定しTarget URLのEnter suffixに付け加えてやる必要があります。
#まとめ
Target URLのEnter suffixにはリクエストパラメータのフィールドを指定する必要がありました。またレスポンスパラメータはPATHの書き方やそのDATA TYPEに工夫が必要でした。しかしレスポンスパラメータの設定等は、ワンクリックで且つGUIで設定できる点が非常に便利であり、Konyの魅力の1つであると思います。
しかし、これらの書き方等の情報はKonyの公式ドキュメントには記載されていない部分で落とし穴になりやすい部分かと思われましたので、本記事に記載しました。少しでも参考になればと思います。
これらの手順でIntegration Serviceを作成したら次はObject Serviceを作成していきます。