Postal Search APIs & Solutions
Postal Search APIs & Solutions
  • チュートリアル
  • ダイジェスト
  • リファレンス
  • デモ
  • テスト
  • 構築キット
  • with Gadgets
  • with jQuery
  • with Microformats
  • よくある質問
  • お問い合わせ
  • 利用規約
  • フォーラム
  • ブログ
Design by
Studio7designs
opensourcetemplates.org
ホーム

Postal Search Ajax API 構築キット

Postal Search Ajax API 構築キットは、あなたの WEB サーバに Postal Search Ajax API の機能を構築するためのパッケージ です。本 API 構築キットを使うと、あなたの WEB サーバに Postal Search APIs & Solutions のサーバとは完全に独立した形で Postal Search Ajax API の環境を構築でき、あなたの WEB サーバのみで独立して運用できるようになります。

本 API 構築キットは Perl や PHP といった CGI プログラムを必要としません。本 API 構築キットの プログラムやデータベースは、すべて JavaScript で構成 しています。ですので、FTP を使ってファイルをアップロードでき、JavaScript でプログラミングができる方なら、以下の手順にしたがって簡単に導入できるようになっています。

Postal Search Ajax API 構築キットの構成図

郵便番号と住所のデータベースは、あなたの WEB サーバで管理するため、あなたの WEB サーバにデータを格納し、その最新データを維持する必要があります。最新のデータベースは、本サイトで定期的に公開していますので、必要に応じてダウンロードして最新データに差し替えてください。

1. API 構築キットをダウンロードする

はじめに Postal Search Ajax API 構築キットをダウンロード します。

これ以降、ダウンロードした API 構築キットのファイル名を postal-20070906.zip として説明します。 ファイル名の内 20070906 の部分は API 構築キットをリリースした日付を表しています。 この日付を置き換えて読み進めてください。

2. API 構築キットを解凍する

次に、ダウンロードしたファイルを解凍します。ファイルを解凍すると、次のとおりファイルが展開されますので、その内容を確認してください。

ファイル構成:
postal-20070906/
+-- js/
    +-- postalua.js
+-- lookup/
    +-- ###.js
+-- coder/
    +-- ###.js
+-- AGREEMENT.txt
+-- LICENSE.txt
+-- jQuery-LICENSE.txt
+-- form1.html
+-- form2.html
js / postalua.js

Postal Search Ajax API の JavaScript ファイルです。 このファイルには jQuery という JavaScript Library とそのプラグインも含まれます。

lookup / ###.js
coder / ###.js

郵便番号と住所を格納したデータベースファイルです。合計 1,994 の JavaScript ファイルから成り立ちます。

AGREEMENT.txt

Postal Search APIs & Solutions の利用規約を表したテキストファイルです。

LICENSE.txt
jQuery-LICENSE.txt

Postal Search Ajax API と jQuery のライセンスを表したテキストファイルです。

form1.html
form2.html

Postal Search Ajax API を使った送信フォームのサンプルファイルです。 一般的な JavaScript 構文を使ったものと jQuery を使ったものの 2通りが含まれます。

ディレクトリ名の内 20070906 の部分は API 構築キットをリリースした日付を表しています。 この日付を置き換えて読み進めてください。

3. API 構築キットをアップロードする

上記のディレクトリ名を postal-20070906 から postal に変更し、このディレクトリをそのまま丸ごと WEB サーバにアップロードします。

これ以降、アップロードしたディレクトリは http://example.com/postal/ の URL でアクセスできるものとして説明します。 あなたがアップロードした WEB サーバのドメイン名とディレクトリに置き換えて読み進めてください。

4. API 構築キットを利用する

Postal Search Ajax API を使う HTML ページに、次の script タグを貼り付けます。

貼り付けコード:
<script type="text/javascript" src="/postal/js/postalua.js"></script>
<script type="text/javascript"><!--
Postal.url = '/postal';
--></script>

1行目の script タグの src 属性には Postal Search Ajax API の JavaScript ファイルを指定します。例では /postal/js/postalua.js としています。

3行目の Postal.url には API 構築キットをアップロードしたディレクトリを指定します。このとき末尾の / は不要です。例では /postal としています。

5. API 構築キットを活用する

以上で Postal Search Ajax API を利用する準備が整いました。API の使い方は Postal Search Ajax API ドキュメント をご覧ください。

Copyright© 2007 LEARNING RESOURCE LAB and the Postal Search APIs & Solutions team.