intra-mart Accel Platform 郵便番号検索(日本) 仕様書 第3版 2019-08-01

3. 概要

3.1. 郵便番号検索機能とは

郵便番号検索機能とは、日本郵便株式会社の提供している郵便番号データを取り込み、郵便番号や住所の一部から住所を検索するための機能です。
取り込む郵便番号データについては以下を参照してください。
取り込んだ郵便番号データの検索は、 intra-mart Accel Platform 上に構築したアプリケーションや外部アプリケーションから利用できます。

3.2. 仕様

郵便番号検索機能を利用するには、はじめに日本郵便株式会社のサイトより郵便番号データをダウンロードし、 intra-mart Accel Platform へインポートする必要があります。
郵便番号データのインポートはインポート用のジョブから行います。詳しくは以下を参照してください。
郵便番号データのインポートを行ったら、以下のURLへリクエストを送信すると検索結果を取得できます。検索結果はJSONで返却されます。
http://<HOST>:<PORT>/<CONTEXT_PATH>/api/zipcode/search
送信するリクエストのパラメータや、検索結果のJSON形式については以下を参照してください。
郵便番号検索を利用できるユーザを制限したい場合は、認可設定を行う事で利用可能ユーザを設定できます。
対象のリソースは以下の通りです。
画面・処理 - 郵便番号検索 - 郵便番号検索

3.3. モジュール

郵便番号検索機能を利用するには、下記のモジュールが必要です。
../../_images/zipcode_search_module.png

3.4. 制限事項

制限事項はリリースノートに記載されています。必ず制限事項を確認してください。