郵便番号APIリファレンス
Actplex 郵便番号APIサービスでは、最新の郵便番号情報を様々な検索方法で提供しています。
ここではAPIサービスの基本仕様について、記述しています。
基本仕様
各APIは指定されたURLに対して、リクエストパラメータを指定しGETにてHTTPSクエリを発行することで利用することができ、各APIの呼び出し結果(レスポンス)はXMLの形で取得できます。各APIのリクエスト、レスポンス仕様の詳細は各API仕様詳細をご覧ください。
要素 | 説明 |
言語 |
郵便番号APIサービスは日本語と英語に対応しています。langパラメータで以下の通り設定します。
|
通信プロトコル | APIクエリはSSL通信(http)を指定してください。 |
文字コード | APIクエリへの日本語はUTF8で指定してください。 APIクエリの結果はUTF8で返します。 |
フォーマット | APIクエリの結果はXMLフォーマットで返します。 |
各サービスAPI リファレンス
各サービスAPIリファレンスの詳細は、以下をご覧ください。
エラー仕様
各APIではStatusCodeを用意しています。正常に検索結果が得られた場合、StatusCodeは200を返します。
エラーが発生した場合、以下のStatusCodeを返します。
StatusCode | 説明・対応方法 |
400 | 呼び出されたサービスが不明です。正しいサービス名を指定してください。 |
401 |
言語設定が正しくありません。langを指定しないかlang=JP、もしくはlang=ENを指定してください。 |
402 |
課金状況に問題があります。次の内容を確認してください。
|
404 | APIクエリを正しく処理しましたが、対象となる郵便番号/住所を見つけることができませんでした。 |
エラーサンプル
<?xml version="1.0" encoding="utf-8"?>
<Response>
<Result>
<StatusCode>401</StatusCode>
</Result>
</Response>