郵便専門ネットでは、XML-RPCを使って、郵便番号の存在チェックや住所の取得ができます。
郵便専門ネットのXML-RPC API (ver.2.2)
URI
| ホスト名 | yubin.senmon.net |
| ポート番号 | 80 |
| パス | /service/xmlrpc/ |
メソッド一覧
| 戻り値 メソッド (パラメータ) | 機能 |
|---|---|
| string yubin.getVersion () | 郵便番号データのバージョン文字列を返します。 |
| int yubin.getMaxFetchCount () | 一度に取得できるデータ件数を返します。 |
| int yubin.getFetchCountByPostcode (string postcode) | 引数に指定した郵便番号で何件ヒットするのかをint型で返します。 yubin.fetchAddressByPostcodeで途中で切れてしまった場合でも、このメソッドで何件ヒットしたのかを調べることができます。 |
| string yubin.getPrefName (string prefectureCode) | 引数に都道府県のコード（地方公共団体コードの先頭2文字）を渡すと都道府県名を返します。 |
| boolean yubin.postcodeExists (string postcode) | 郵便番号で存在チェックし、存在したらtrue、存在しなければfaultCodeを返す。 |
| string yubin.postcodeToJiscode (string postcode) | 郵便番号を5桁の全国地方公共団体コード／JISコード／市町村コードに変換して返します。 |
| string yubin.postcodeToJiscode6 (string postcode) | 郵便番号を6桁（チェックデジット付き）の全国地方公共団体コード／JISコード／市町村コードに変換して返します。 |
| array of struct yubin.fetchAddressByPostcode (string postcode) | 郵便番号から住所を返す。事業所の郵便番号だった場合は事業所の住所を返す。 パラメータのpostcodeには7桁の郵便番号を全部指定する。完全一致で検索します。戻り値の日本語部分は文字コードがUTF-8です。XML-RPCの仕様には文字コードの取り扱いについて明確に書かれていないので、XMLのデフォルト値にしました。 戻り値はstructのarrayで返ってきます。structの項目は以下の通り。 |
struct 住所情報型
| 項目 | フィールド名 | 型 | 説明 |
|---|---|---|---|
| 郵便ID | yid | int | 郵便番号データにはユニークなIDが付いていない。管理上必要なため当方で発番したもの。このIDは全国郵便番号一覧のバージョンが変ると同じIDが別の住所、事業所に割り振られる可能性がある。 |
| データタイプ | data_type | string | p=住所、j=事業所 |
| 地方公共団体コード | jiscode | string | |
| 郵便番号 | postcode | string | |
| 都道府県名 | pref | string | UTF-8 |
| 都道府県名カナ | pref_kana | string | UTF-8;data_type=pのみ |
| 市区 | city | string | UTF-8 |
| 市区カナ | city_kana | string | UTF-8;data_type=pのみ |
| 町村 | town | string | UTF-8 |
| 町村カナ | town_kana | string | UTF-8;data_type=pのみ |
| 事業所名 | addr_name | string | UTF-8;data_type=jのみ |
| 事業所名カナ | addr_name_kana | string | UTF-8;data_type=jのみ |
| 町域番地 | other | string | UTF-8;data_type=jのみ |
- 必ずfaultCodeをチェックしてください。見つからない場合、パラメータ不正の場合、システム障害の場合などにfaultCodeが返ってきます。
- 元データの性質上、市区と町村の区切りは明確ではありません。市区部分に町が入っている場合もあります。
- 2007.12現在、最大で100件まで返すことができるようになっています。 それ以上の場合は、エラーとなってfaultCodeが返ります。条件を厳しくしてやり直してください。 この制限については負荷状態をみて変更する場合があります。
サンプル
Delphiによる使用例
Windows用のXML-RPCクライアント（フリーソフト）をご覧ください。
以下からダウンロードしてご利用頂けます。
ファブリス-ソフトウエア
Delphi5のソースと郵便専門ネット用のリクエストファイルを同梱しています。
XML-RPCを利用したサイトの開発者の方には便利だと思います。どうぞご利用ください。
シンプルな検索機能の例として、郵便専門ネットクライアント（フリーソフト）をご覧ください。
当サイトのXML-RPC APIを実装したものです。ダウンロードしてご利用頂けます。
ソースは添付していませんが、ほとんどは上のXML-RPCクライアントのソースから流用したものです。
Pythonによる使用例
XML-RPCで郵便番号から住所を取得するPythonスクリプトをご覧ください。 Delphi、PHP、Pythonでは圧倒的にPythonが簡単です。標準ライブラリだけで動きます。 (2006.4.14)
PHPによる使用例
PHP版のXML-RPCクライアント のサンプルクラスをご覧下さい。 (2007.12.9)