jQuery UI Autocomplete 用 郵便番号検索サービス
当サイトは jQuery UI Autocomplete のための無料の郵便番号検索サービスを提供し、API を公開しています。
郵便番号検索サービス使用例
下のフォームでは、郵便番号、住所および事業所名が Autocomplete に対応しています。
郵便番号は3桁以上、住所と事業所名は2文字以上を入力してみてください。
該当するデータがドロップダウンメニューで表示されます。目的のデータが出てこない場合は、郵便番号の桁数や住所・事業所の文字数を追加してください。
ドロップダウンメニューから目的のデータを選択すると、郵便番号、住所、住所２（または住所２のヒント）、事業所名、地方公共団体コードの欄にデータが転記されます。
郵便番号は先頭から順に入力する必要がありますが、住所と事業所名については、非常に柔軟な検索をします。
- 「下京区」のように、住所の途中から入力しても構いません。
- 読み仮名を入力しても構いません。平仮名でも片仮名でも受け付けます。半角カナでさえも大丈夫。たとえば、「きょうと」、「キョウト」または「ｷｮｳﾄ」。
- スペース、セミコロン(;)、コンマ(,)、読点(、)で区切って、絞り込み検索可能。例えば「京都、祇園」。
検索サービス API の仕様
- アドレス : https://tools.softark.net/zipdata/api/search
- 引数 :
-
- callback : JSONP コールバック関数名
- mode : 検索モード
-
- 0 : 郵便番号から検索
- 1 : 住所および事業所名から検索
- 2 : 事業所名から検索
- term : 検索語
-
- mode = 0 の場合 : 郵便番号(先頭から3桁以上)
- mode = 1 の場合 : 住所または事業所名の断片(2文字以上)
- mode = 2 の場合 : 事業所名の断片(2文字以上)
- max_rows : 検索結果取得最大行数
- biz_mode : 事業所データ対応モード
-
- 0 : 通常のデータのみを検索（事業所を除外）
- 1 : 事業所のデータのみを検索
- 2 : 通常のデータと事業所のデータの両方を検索
- sort : ソート
-
- 0 : 郵便番号（昇順）
- 1 : 住所（漢字コード昇順）
- 2 : 事業所名（漢字コード昇順）
- 戻り値 : JSONP
-
- 関数名 : 引数 callback で指定された関数名
- JSON データ : 下記のプロパティを持つオブジェクトの配列
-
- zip_code : 郵便番号
-
- ハイフンで上位3桁と下位4桁に分けた形式
- 例 : 600-8022
- pref : 都道府県名
-
- 例 : 京都府
- town : 市区町村名
-
- 例 : 京都市下京区
- block : 町域名
-
- 例 : 稲荷町
- street : 住所の詳細または補足説明
-
- 町域名の下に続く丁目、小字、番地、ビルの階層など。
- 住所の詳細というよりは、町域名に関する補足説明である場合が多い。 つまり、複数の地域が併記されていたり、「1丁目～３丁目」のような範囲であったり、「○○を除外」という例外が記載されていたりして、 そのままの形では住所欄に入力できないデータであることが多いので、取り扱いに注意が必要である。
- ただし、事業所のデータの場合は、そのものずばりの住所の詳細情報が記されている。
- 例 : 河原町通四条下る、河原町通四条下る2丁目
- biz : 事業所フラグ
-
- 0 : 通常のデータ
- 1 : 事業所のデータ
- biz_name : 事業所名
-
- 例 : 多可町役場 加美地域局
- town_code : 全国地方公共団体コード (JIS X0401, X0402)
-
- 例 : 28365
検索サービス API の使用方法
この検索サービスを jQuery UI Autocomplete で使用するフォームのサンプルを Gist で公開しています。
内容としては、このページのフォームの部分だけを抜き出して単一の HTML ファイルにまとめたものです。短いソースですが、ダウンロードすれば、そのままローカルでも郵便番号検索の Autocomplete が動作する筈です。
jQuery および jQuery UI について少し知っている人であれば、上記の API 仕様と合せて読むことで、比較的簡単に実用上のノウハウを取得できると思います。
ライセンス
自由に使って下さい。無料、ただし、無保証です。フィードバックをいただくと有難く思います。
最終更新日 : 2018-10-12
