みなさんはウェブAPIについてご存じでしょうか？
ウェブAPIとは、簡単に言うとオンライン上で利用できるアプリケーションのことです。GoogleやYahoo、Microsoftなどが提供する地図サービスや、Amazon、楽天などのショッピングサイトが提供する商品検索など、便利なサービスがウェブAPIとして公開されていて、個人用であれば大抵のものは無料で利用することができます。
このウェブAPI、ちょっと試してみたいなんて場合には、ブラウザのURL欄にそれぞれのウェブAPIごとに用意されているリクエストURIを入力することで実行することができます。
しかし、中には複雑なものがあって、APIキーを送信ヘッダーに設定しないといけなかったり、POSTリクエストが必要な場合などは、外部ツールを使って実行する必要があります。
フローサービスには、RESTコンポーネント
を使って簡単にウェブAPIの動作を確認する方法があるので紹介したいと思います。
今回使用するウェブAPIはこちらを利用します。
郵便番号検索API（http://zipcloud.ibsnet.co.jp/doc/api）
このウェブAPIを使って、郵便番号から住所を検索してみましょう。
・フローの作成
-
RESTコンポーネントを配置します。
-
RESTコンポーネントをダブルクリック、もしくは右クリックメニューから「テストの実行」を選択します。
-
RESTのテストダイアログが表示されるので、基本タブのURLフィールドに次の値を入力します。
http://zipcloud.ibsnet.co.jp/api/search
-
URLパラメータータブに次のパラメーターを追加します。
パラメーター名 データ型 値 zipcode String 1400014
これで完成です。早速実行してみましょう。
「テスト実行」ボタンをクリックします。
画面左のResponseタブに結果が表示されました。
レスポンスの上部に表示されているのがレスポンスヘッダーで、その下に表示されているのがレスポンスボディになります。
ウェブAPIの動作確認だけであれば、ダイアログを閉じて終わりです。
あっ、ちょっと待って下さい。
テストダイアログで入力したパラメーターは、RESTコンポーネントのプロパティには反映されていません。テスト用に後で使うかもしれないので保存しておきましょう。
「プロパティのインポート」ボタンをクリックします。
これでRESTコンポーネントのプロパティに反映されました。
RESTのテストダイアログには他にも、レスポンスからフィールド定義を作成したり、パラメーターをリクエストボディに指定してPOSTやDELETE、PUTを実行する機能などがあるので、またの機会に紹介したいと思います。
それでは。