郵便番号・住所検索API Ver 1.0 マニュアル

はじめに

郵便番号・住所検索APIは、お問い合わせフォームや注文フォームなどの住所入力を支援するためのツールです。郵便番号を入力することで、候補となる住所一覧を表示させ、それを選択させることで、住所入力欄に住所がセットされます。

所定のタグを貼り付けるだけで、すでにご利用のフォームのHTMLをそのままご利用頂けます。

郵便番号情報は、日本郵政のゆうびんホームページで公開されている郵便番号データ（事業所の個別郵便番号を含む）を採用しています。いつでもご自分で最新の郵便番号データをご利用頂くことができます。

郵便番号・住所検索APIは、開発者向けに、APIとしての機能が実装されています。郵便番号から住所を検索する仕組みとして、REST方式によりHTTPリクエストを送信することで、その住所情報の結果をJSONやXML形式で受け取ることができます。郵便番号から住所を検索して、それを表示する機能をご自分でご用意される場合を想定しています。

※本システムは、お客様サーバーにシステムを設置してご利用頂くものです。APIをウェブサービスとして弊社がご用意するものではございません。

主な機能

簡単セットアップ

郵便番号・住所検索APIはインストーラー付きです。インストーラーとなるCGIをブラウザーでアクセスするだけで、必要なファイルを適切に設定し、すぐにご利用いただける状態にします。

ブラウザーから設定

すべての設定をブラウザーを使って行います。テキストエディタを使った難しい設定はありません。初心者の方でも簡単にセットアップできます。また ssh の環境も必要ありませんので、ssh の環境を提供していないホスティングサービスをご利用の場合でも、ご利用いただけます。

郵便番号情報の簡単アップデート

日本郵政が公開する郵便番号データ（事業所の個別郵便番号を含む）はほぼ毎月更新されています。本システムでは、ご自分で必要に応じていつでも最新にデータをアップデートする仕組みを管理メニューにご用意しました。

あらゆるフォームに適用可能

郵便番号と住所入力欄は、サイトによって多種多様です。郵便番号・住所検索APIでは、所定のタグをフォームに埋め込むだけで、今ご利用のフォームに簡単に住所検索機能を組み込むことができます。管理メニューにページ組込タグを生成するナビゲーターをご用意しました。現在ご利用になっているフォームにあわせてパラメータを調整するだけで、必要な組込タグをご案内します。

開発者向けAPI

郵便番号・住所検索APIは、すぐにフォームに住所検索機能を組み込めるよう、オリジナルのユーザー・インタフェースをご用意しています。しかし、サイト・オーナー様によっては、独自のデザインや独自の機能を持ったユーザー・インタフェースを作りたい場合もあるでしょう。郵便番号・住所検索APIでは、名前の通り、住所検索用の API をご用意しております。所定のパラメータを付けて HTTP リクエストを送る方式（REST方式）によって、住所検索結果を JSON または XML フォーマットで取得することができます。

アクセス制限

郵便番号・住所検索APIは、自サイトに設置するタイプのシステムです。そのため、第三者から勝手に利用されることは避けたいものです。郵便番号・住所検索APIには、呼び出し元のページの URL や IP アドレスによってアクセスを制限する機能をご用意しております。

パフォーマンス

住所検索によってサーバーに負荷がかからないよう、いくつかの対策が施されています。一度検索された結果は本システム内でキャッシュすることで、データベースへのアクセスを低減します。また、ブラウザー側にも検索された結果を保存※1することで、無駄なサーバーへのリクエストが発生しないよう考慮されています。

リーズナブルな料金体系

郵便番号・住所検索APIは、サイト（ドメイン）ごとのライセンス料金体系を採用しています。1ライセンス分の料金のみで、継続してご利用いただけます。月々の料金のお支払は一切不要ですので、とてもリーズナブルです。

※1 ブラウザー側に検索結果を保存する仕組みとして Web Storage を採用しています。Internet Explorer 8 以上、または、それ以外の最新ブラウザーには Web Storage が実装されていますが、古いブラウザーではブラウザー側でのキャッシュ保存は有効になりません。

動作環境

本 CGI が動作するサーバー環境は以下の通りです。

必須条件

以下の条件は、本 CGI が動作する最低限の環境です。この条件が満たされない場合は、本 CGI は動作しませんので注意してください。

  • UNIX 系サーバー（Linux や FreeBSD など）※1
  • Perl 5.8.1 以上
※1 Windows サーバでも動作するよう考慮されておりますが、動作保証の対象ではありませんのでご了承ください。

データベース環境

以下のいずれかのデータベース環境が最低 1 つはインストールされている必要があります。

  • SQLite 3 以上（Perl モジュール DBI および DBD::SQLite が必要です）
  • MySQL 4.0.0 以上（Perl モジュール DBI および DBD::mysql が必要です）
  • Berkeley DB（Perl モジュール DB_File が必要です）

シェアウェア料金

料金

1 サイトあたり ￥5,250（本体価 ￥5,000／消費税 ￥250）

  • 本CGIの料金は、ご利用のサイトごとに発生いたします。同一サイト内であればいくつ設置して頂いても構いません。
  • 同一サイトとは、運営主体（運営者、運営組織）が同一で、かつ、同一の内容をテーマとした範囲を指します。
  • 運営主体が同一でも、まったく異なる主旨のサイトの場合には、別のサイトとし、それぞれにライセンスが必要となります。
  • 総合情報サイトのように、さまざまなテーマを取り上げたサイトの場合には、それは同一のサイトとします。各コーナーを委託して作成してもらっている場合も、同様です。ただし、それぞれのコーナーが、その総合サイトに含まれていることが分かることが前提です。明らかに、別のサイトで、かつ、リンクを張った だけの場合には、別サイトとさせていただきます。俗に言う、姉妹サイトは、別サイトとみなします。
  • シェアウェア料金をお支払いいただく前に、十分ご試用いただき、ご納得いただいてからお支払いいただきますようお願いいたします。

お支払い方法

クレジットカード決済、コンビニ決済、Vectorシェアレジ、銀行振込をご用意しております。シェアウェア料金のお支払はこちらからどうぞ。

ご購入手続き