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

詳細設定

本 CGI のデータベース、パフォーマンス、アクセス制限に関しては、管理メニューの上にある「詳細設定」メニューにて設定することができます。

このボタンは青の背景に白で「詳細設定」と書かれています。

画面の説明に従って処理を進めてください。

データベース

本 CGI では、郵便番号・住所情報のデータベースとして、いくつかのエンジンをサポートしています。選択したデータベースエンジンに応じて設定内容が異なります。

データベースエンジン

本 CGI では、データベースエンジンとして、SQLite、MySQL、DB_File をサポートしています。データベースエンジン設定欄では、ご利用のサーバーがサポートしているエンジンのみが選択できるようになっています。

データベースエンジン指定欄には、SQLite、MySQL、DB_File のいずれかひとつを選択するラジオボタンが用意されています。

図:データベースエンジン指定欄

もし SQLite が選択できるようであれば、特に理由がない限りは SQLite を指定してください。郵便番号から住所を検索するパフォーマンスは、当社調べてでは SQLite が最も早く、DB_File がもっとも遅いという結果でした。

なお、すべてのデータベースエンジンが選択可能になっているからといって、必ずしも利用できるとは限りません。この設定欄では、あくでまでも該当のデータベースエンジンを利用するに当たり必要なモジュールがご利用のサーバーにインストールされているかどうかをチェックしているに過ぎません。そのため、データベースエンジンを選択する場合は、ご利用のサーバーが本当に該当のデータベースエンジンをサポートしているかどうかを事前にご確認ください。

データベースエンジンを選択したら、その下に現れる設定を引き続き行ってください。SQLite、DB_File のいずれかを選択した場合は DB ファイル情報設定欄が、MySQL を選択した場合はデータベース接続情報設定欄が表示されます。

DB ファイル情報

データベースエンジンに SQLite または DB_File を選択すると、DB ファイル情報設定欄が表示されます。

DB ファイル情報設定欄には、DB ファイル格納ディレクトリパスを設定するためのテキスト入力フィールドが一つあります。

図:DB ファイル情報設定欄

通常は、デフォルトのディレクトリパスがプリセットされています。特に理由がない限りは変更する必要はありません。

変更したい場合は、パスの最後にスラッシュを入れないでください。また、事前に指定のディレクトリを生成しておいてください。

データベース接続情報

データベースエンジンに MySQL を選択すると、データベース接続情報設定欄が表示されます。

データベース接続情報設定欄にはテキスト入力フィールドが 5 つあります。それぞれには、DB ユーザー名、DB パスワード、DB 名、DB ホスト名、DB ポート番号を指定します。

図:データベース接続情報設定欄

ご利用のサーバーの MySQL 情報を設定してください。DB ポート番号以外はすべて必須です。DB ポート番号に指定がなければ、MySQL が採用するデフォルトのポート番号が自動的に適用されます。

パフォーマンス

データベースを構築する処理、および、郵便番号から住所を検索する処理において、いくつかのパフォーマンスに影響するパラメータがあります。通常はデフォルト値のままで構いませんが、細かくチューニングしたい場合は、お好みに合わせて設定してください。

データベース構築の1回あたりの処理バイト数

データベースを構築する際、郵便事業株式会社(日本郵便)が配布している郵便番号(CSV形式)ファイルが大きいため、一度に処理することはできません。 そのため、本システムでは、所定のサイズに分割して構築を行います。ここに、分割するサイズをKB(キロバイト)単位で指定してください。指定可能な値は、1~999です。

データベース構築の1回あたりの処理バイト数の設定欄には、キロ・バイト数を表す数値を入力するためのテキスト入力フィールドが一つあります。

図:データベース構築の1回あたりの処理バイト数の設定欄

もし、データベース構築で処理に時間がかかりエラーになってしまう場合は、この値を小さい値に変更することで解決する可能性が高くなります。

逆に、もっと早く構築処理を終わらせたい場合は、この値を大きくしてみてください。ただし、その分だけ、一度にかけるサーバー負荷も高くなりますのでご注意ください。

データベース構築の1回あたりの処理インターバル

データベースを構築する際、分割された処理ごとに、一定の待ち時間を設けることができます。待ち時間を設けることにより、データベース構築処理時のサーバーの負荷低減が期待できます。指定可能な値は、0~9999です。

データベース構築の1回あたりの処理インターバルの設定欄には、ミリ秒数を表す数値を入力するためのテキスト入力フィールドが一つあります。

図:データベース構築の1回あたりの処理インターバルの設定欄

もし、データベース構築処理時のサーバー負荷が高すぎるようであれば、この値を大きい値に変更することで解決する可能性が高くなります。

Web Storage の有効日数

Web Storage に対応したブラウザーを使って住所検索をした場合、一度検索した結果をブラウザーに蓄積し、次回以降、同じ郵便番号を検索した場合には、サーバーにリクエストせず、ブラウザーに蓄積したデータを表示します。こうすることによって、素早く検索結果を表示することができるだけでなく、サーバーの負荷の低減にもつながります。

ここでは、ブラウザーに蓄積したデータの有効日数を指定してください。指定可能な日数は 0 ~ 365 です。0 を指定すると、Web Storage 機能は無効になります。

Web Storage の有効日数の設定欄には、日数を表す数値を入力するためのテキスト入力フィールドが一つあります。

図:Web Storage の有効日数の設定欄

Web Storage は、Internet Explorer 8 以上、Firefox、Chrome、Opera、Safari といった主要なブラウザーはすべてに実装されています。一般的なサイトであれば、ほとんどの訪問者は Web Storage をサポートしたブラウザーを使ってアクセスしているはずです。そのため、できる限り、本機能を有効にすることをお勧めします。

郵便事業株式会社(日本郵便)が配布している郵便番号(CSV形式)ファイルを使って最新の情報にデータベースを更新した場合は、次回アクセスがあった際に Web Storage のデータは破棄され、最新のデータが優先されます。

アクセス制限

本 CGI の住所検索機能に関して、アクセス制限を設定することができます。必要に応じて設定してください。

なお、このアクセス制限は管理メニューへのアクセス制限とは異なります。管理メニューへのアクセス制限は、システム設定をご覧ください。

利用サイト制限

ご利用サイトのURLを http:// から指定してください。URLを設定すると、郵便番号検索のリクエストを受けた際に、リクエスト元の URL をチェックします。ここで指定した URL が前方一致した場合のみ、応答します。もし一致しなかった場合は、403 Forbidden を返します。

リクエスト元の URL は、ブラウザーがサーバに送信する Referer(リファラー)と呼ばれる情報を使います。もしブラウザーがリファラーを送信しない場合はエラーとなりますので、ご了承ください。

この制限は、ウェブ経由およびAPI経由のいずれにも適用されます。

利用サイト制限の設定欄には、本 CGI を利用するサイトの URL を入力するためのテキスト入力フィールドが一つあります。

図:利用サイト制限の設定欄

ウェブの訪問者には、あえてブラウザーが Referer(リファラー)を送信しないように設定している人もいます。そのため、いたずらや、他サイトからの不正利用が認められた場合にのみ設定してください。

IP アドレス制限

郵便番号検索において、許可する IP アドレス帯域もしくは拒否する IP アドレス帯域を指定してください。192.168.1.1/32 といった具合にビットマスクをつけて指定してください。いくつでも指定可能です。

許可する IP アドレス帯域を指定すると、拒否する IP アドレス帯域の設定は無視されます。いずれか一方のみを指定するようにしてください。

この制限は、ウェブ経由およびAPI経由のいずれにも適用されます。

IP アドレス制限の設定欄には、許可する IP アドレス帯域を設定するためのテキストエリアと、拒否する IP アドレス帯域を設定するためのテキストエリアがあります。

図:IP アドレス制限の設定欄

「許可する IP アドレス帯域」に IP アドレス帯域を設定すると、指定した IP アドレス帯域からのアクセスのみを許可します。それ以外の IP アドレスからのアクセスはすべて拒否されますので注意してください。

「許可する IP アドレス帯域」は、主に、特定のサーバー・プログラムから本 CGI の API を利用する場合に使います。

いたずらや、他サイトからの不正利用が認められた場合に、所定の IP アドレス帯域からのアクセスを拒否したい場合は、「拒否する IP アドレス」に該当の IP アドレス帯域を設定してください。