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

インストール

とりあえず、動作するようにしてみましょう。ここでは、必要最低限の設定をご案内します。

  1. Perlパス設定
  2. CGIをサーバに設置する
  3. セットアップ開始
  4. CGI動作確認

Perl のパス設定

CGI をサーバで実行させるためには、CGI ファイルの 1 行目に Perl のパスを記述する必要があります。zip フォルダ内に install.cgi というファイルがあります。テキストエディタで install.cgi を開いてください。1 行目に次のコードが記述されています。

#!/usr/bin/perl
1 行目の Perl のパス

この行を、お使いのプロバイダー、もしくはレンタルサーバ業者の指定通りに修正してください。通常、ほとんどのレンタルサーバでは書き直す必要はありません。レンタルサーバ業者の指定と異なる場合のみ、書き直して下さい。

もしご利用のサーバの Perl のパスが /usr/local/bin/perl であれば、#!/usr/local/bin/perl と書き直します。パスの先頭に #! を入れ忘れることがないよう注意してください。書き直したら、保存してください。ただし、保存する際には、改行コードを LF としてください。

なお、本 CGI 関連ファイルの文字コードは UTF-8 です。CGI ファイルをテキストエディタで開く場合は、必ず UTF-8 対応のテキストエディタを使ってください。また、保存する際にも、UTF-8 で保存してください。

CGI をサーバに設置する

以下の手順に従って、CGI をサーバに設置してください。

手順1. 転送先

zip フォルダをまるごと、CGI が実行できる領域に FTP ソフトを使ってアップロードしてください。 サーバにアップロードする際には FTP 専用ソフトを使ってください。 ホームページ作成ソフトについている FTP 転送機能を使うと、CGI 関連ファイルが書き換えられてしまう可能性があり、正しく動作しませんので、注意してください。

もし、ご利用のサーバで、cgi-bin といった名前の特定のディレクトリでしか CGI が実行できない場合には、zip フォルダ内にある static フォルダは転送しないでください。

この場合、別途、static フォルダを、HTML ファイルや画像ファイルを設置する場所にアップロードしてください。

手順2. パーミッションの変更

アップロードが完了したら、zip フォルダ内にある install.cgi のパーミッションを、レンタルサーバ事業者指定のパーミッションに変更してください。

どのサーバでもおおむね 704 (rwx---r--) もしくは 705 (rwx---r-x) で CGI が動作します。

セットアップ開始

ブラウザーで、先ほどアップロードした zip フォルダ内の install.cgi にブラウザーでアクセスしてください。そして、以下の手順に従ってセットアップを進めてください。

Step 1. staticディレクトリURLの設定

install.cgi にアクセスすると、ご利用のサーバによって次の2通りのいずれかの画面が表示されます。表示される画面に応じて対処方法が異なります。

パターン 1.

多くのレンタルサーバでは、次のような画面が表示されます。この画面が表示された場合は、画面下の「次へ」ボタンを押して Step 2 に進んでください。

問題なければ、「static ディレクトリの URL の設定」は、上部のヘッダーは青色に、右側の進捗表示欄は黄色の背景になります。つまり、スタイルが適切に適用された画面になります。

static ディレクトリ URL の設定画面(正常な場合)
パターン 2.

static ディレクトリが正しく認識できなかった場合は、次のような画面が表示されます。

static ディレクトリが正しく認識できないと、ハイパーリンク以外はすべて白黒で表示されます。さらに期待通りのレイアウトでコンテンツが表示されません。つまり、スタイルが適用されていない画面になります。

static ディレクトリ URL の設定画面(異常な場合)

cgi-bin といった特定のディレクトリでないと CGI が動作しない環境となっている場合は、この画面が表示されます。このようなディレクトリ内では、画像ファイル等のような CGI ファイル以外のファイルにアクセスすることができません。

CGI 関連ファイルをサーバにアップロードした際に、static ディレクトリを別の場所にアップロードした場合は、この画面の「イメージディレクトリURL」欄にstatic ディレクトリのURLを指定して「設定」ボタンを押してください。別途、static ディレクトリを通常のHTMLファイルを設置する場所にアップロードしていない場合は、事前にstatic ディレクトリを別途アップロードしておいてください。

イメージディレクトリURLの設定は、zip ディレクトリ内からみた相対 URL か、もしくは http:// から指定してください。また最後にスラッシュを入れないでください。

static ディレクトリのURLが正しく設定されると、パターン 1.の画面に変わります。パターン1の画面になるまでは「次へ」のボタンは押さないでください。

Step 2. CGI設置診断セットアップ

このステップでは、CGI ファイルの設置状況を診断します。次の画面が表示されたら、「診断」ボタンを押してください。

画面上に診断ボタンがひとつあります。

CGI 設置診断セットアップ画面(診断前)

もし CGI がファイル所有者権限で実行されるサーバ環境であれば、自動的にファイルパーミッションの変更や Perl パスの修正を行います。そうでないサーバ環境の場合は、自動的にセットアップは行われません。エラーの指示に従って CGI のセットアップを手動で行い、繰り返し診断を行ってください。

画面上に診断ボタンがひとつありますが、その下に、「次へ」ボタンが表示されています。

CGI 設置診断セットアップ画面(診断が正常だった場合)

「診断」ボタンを押して、正常にセットアップが完了すると、左の画面のように、画面下に「次へ」ボタンが表示されます。「次へ」ボタンを押して、Step3へ進んでください。

次の画面のように、エラーメッセージが表示されたら、メッセージにしたがって設定を行ってください。設定したら再度「診断」ボタンを押してください。エラーが表示されなくなるまで繰り返しこの作業を行ってください。

診断ボタンの下に、赤字でいくつかのエラーメッセージが表示されています。「次へ」ボタンは表示されていません。

CGI 設置診断セットアップ画面(診断が異常だった場合)

Step 3. データベース設定

郵便番号と住所の情報を格納するためのデータベースの設定を行います。

データベース設定画面には、データベースエンジンを選択するラジオボタンが 3 つあります。選択できる項目は SQLite、MySQL、DB_File です。さらにその下にはDBファイル情報設定欄があります。ここには「DBファイル格納ディレクトリパス」を設定するためのテキスト入力フィールドがひとつあります。

データベース設定画面

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

データベースエンジンを選択すると、それに必要な情報入力欄が変わります。説明を読んで、適切な値を入力してください。

入力が終わったら「設定」ボタンを押してください。正常に登録されればStep4の画面が表示されます。

Step 4. 管理者用ID・パスワード設定

本 CGI の管理メニューを利用するための管理者用 ID とパスワードを設定します。ID およびパスワードに指定できる文字は、半角の英数、ハイフン、アンダースコアです。

管理者用ID・パスワード設定画面には、管理者 ID、パスワード、パスワード再入力の 3 つのテキスト入力フィールドがあります。

管理者用 ID・パスワード設定画面

ここで設定した ID とパスワードは決して忘れることがないようメモしておいてください。ID およびパスワードを忘れてしまうと管理メニューにログインできなくなりますのでご注意ください。

ID とパスワードを入力したら「設定」ボタンを押してください。

セットアップ完了画面

IDとパスワードが正常に登録されればセットアップ完了画面が表示されます。これでセットアップは完了です。

セットアップ完了画面には、ログオン画面へのリンクが用意されています。また、その下にはテキストエリアがあり、その中に、ログオン画面の URL が記載されています。

セットアップ完了画面

本 CGI のログオン画面の URL が表示されますので、この URL を控えておくか、ご利用のブラウザーのブックマークに追加するなどして忘れないようにしてください。

この画面が表示されてからしばらくすると、本 CGI の管理メニューのログオン画面が表示されます。もしいつまで経っても画面が変わらないようであれば、画面に表示されている URL に直接アクセスしてみてください。そして、引き続き「CGI 動作確認」に進んでください。

CGI動作確認

CGIセットアップが完了すると、本 CGI のログオン画面(admin.cgi)が表示されます。この画面(admin.cgi)が管理メニューを閲覧する際の入り口のページとなります。ページアドレスを控えておくか、ブックマークに追加しておくことをお勧めします。

ログオン画面

セットアップの Step4 で設定した管理者 ID とパスワードを入力してログオンしてください。

ログオン画面には、管理者 ID と パスワードのテキスト入力フィールドがあります。その下に「ログオン」ボタンがあります。

ログオン画面

管理メニュートップ

以上で CGI のセットアップは完了です。ログオンが完了すると、管理メニューが表示されます。。

初めて管理メニュートップを開くと、「郵便番号」住所情報のデータベース構築を実施してください。」というエラーメッセージが赤字で表示されます。

管理メニューのトップ画面

この段階では、まだ郵便番号から住所を検索する機能はご利用頂けません。引き続き、データベースの構築に進んでください。