メインコンテンツへスキップ
サインイン Menu

住所取得API

  • 更新

API-Bridge（Client）から、Yahoo!が提供している「郵便番号検索API」を活用すると郵便番号に関する情報を取得することが可能です。

今回は、Yahoo!の郵便番号検索API を利用した方法をご紹介します。

 

【手順】

  1. API-Bridge（Client）の起動


  2. 「F6」新規作成


  3. 「定義KEY」、「定義名」、「API実行URL」、「メソッド」を入力

    定義KEY：任意のKEYを入力します
    定義名：任意の定義名を入力します
    API実行URL：https://map.yahooapis.jp/search/zip/V1/zipCodeSearch
    ※Yahoo!の郵便番号検索API のリクエストURLに記載されているURLをそのまま入力します。

    メソッド：*GET
    ※Yahoo!の郵便番号検索API にGETメソッドのみサポートしていると記載されているので、GETとします。
  4. QUERYパラメータにキーと値を指定
    キー：appid、値：アプリケーションID
    ※必須のパラメータです。Yahoo!から発行したClient IDを入力してください。


    キー：query、値：郵便番号
    ※値に検索したい郵便番号を入力します。


    キー：output、値：json
    ※デフォルトがxml形式となっており今回は、JSON形式で出力したいため、jsonを指定します。



  5. 出力先を指定
    ※今回はQTEMPに出力します。


  6. 「F5」保存でAPIを実行
    ※APIが実行されると一覧画面に戻り、画面下部に結果が表示されます。


  7. 出力結果の確認
    ※QTEMPにファイルが出来上がっていることが確認できます。

    ファイルは、「ROOT_00001」から連番で作成されており、テキスト部分に記載されている内容から、jsonファイルのどの辺りが対応しているか目安としてわかります。
    下図は、「ROOT_00007」の「ROOT_FEATURE_PROPERTY」を参照した結果です。

    ※Yahoo!の郵便番号検索API にレスポンスフィールドの説明が記載されております。



以上が作成手順となります。
この作成したAPIを利用してコマンドから直接CALLすることも可能となり、郵便番号を都度変更して実行することが可能です。
（例）定義KEYを「ZIPAPI」のAPIを実行する場合

APIBRIDGE EXEC(*EXEC) KEY(ZIPAPI) QRKEY(query appid output) QRVALUE('106-6117' '取得したあなたのappid' 'json')

関連記事