PostcodeJP API
PostcodeJP APIは郵便番号・住所検索APIの新しい標準です。住所入力フォームで郵便番号から住所を自動入力する用途に特化した郵便番号データを利用できます。
Actions
|
Action |
Configuration fields |
Data type |
Required? |
|---|---|---|---|
|
郵便番号データバージョンの取得 - 取り扱っている郵便番号データの情報を取得します。 |
|
|
|
|
郵便番号の取得 - 指定された郵便番号に完全に一致する郵便番号リソースを取得します。 |
郵便番号 - 郵便番号または大口事業所個別番号を指定します。 postcode |
String |
|
|
市区町村一覧の取得 - 指定した都道府県の市区町村一覧を取得します。 |
フェッチを開始する位置 - フェッチを開始する位置を示すカーソル（ 直前のレスポンスの「nextCursor」または「prevCursor」）の値を指定します。 cursor |
String |
|
|
取得最大件数 - 取得する最大件数を指定します。 limit |
String |
|
|
|
都道府県コード - 都道府県コードを指定します。 prefCode |
String |
|
|
|
郵便番号一覧の取得 - 郵便番号の完全一致や前方一致で郵便番号リソースを検索します。 |
フェッチを開始する位置 - フェッチを開始する位置を示すカーソル（ 直前のレスポンスの「nextCursor」または「prevCursor」）の値を指定します。 cursor |
String |
|
|
レスポンスに含める項目 - レスポンスに含める項目を指定します。指定された項目のみを取得することができます。 fields |
String |
|
|
|
一般の郵便番号 - 一般の郵便番号を検索対象にするかどうかを指定します。 general |
Choice |
|
|
|
入力値の正規化 - 入力された郵便番号の正規化を行うかどうかを指定します。 normalize |
Choice |
|
|
|
取得最大件数 - 取得する最大件数を指定します。（ 1〜20 ） limit |
String |
|
|
|
大口事業所個別番号 - 大口事業所個別番号を検索対象にするかどうかを指定します。 office |
Choice |
|
|
|
検索方法 - 指定した郵便番号の検索方法を指定します。 startWith |
Choice |
|
|
|
郵便番号 - 郵便番号または大口事業所個別番号を指定します。（ 最大8桁 ） postcode |
String |
|
|
|
郵便番号の検索 - 郵便番号データを住所の一部から検索します。 |
フェッチを開始する位置 - フェッチを開始する位置を示すカーソル（ 直前のレスポンスの「nextCursor」または「prevCursor」）の値を指定します。 cursor |
String |
|
|
レスポンスに含める項目 - レスポンスに含める項目を指定します。指定された項目のみを取得することができます。 fields |
String |
|
|
|
一般の郵便番号 - 一般の郵便番号を検索対象にするかどうかを指定します。 general |
Choice |
|
|
|
取得最大件数 - 取得する最大件数を指定します。（ 1〜20 ） limit |
String |
|
|
|
大口事業所個別番号 - 大口事業所個別番号を検索対象にするかどうかを指定します。 office |
Choice |
|
|
|
検索対象とする住所の一部の語句 - 検索対象とする住所の一部の語句を指定します。複数の語句を指定する場合は、半角スペースで区切ります。 q |
String |
|
|
|
都道府県一覧の取得 - 都道府県一覧を取得します。 |
フェッチを開始する位置 - フェッチを開始する位置を示すカーソル（ 直前のレスポンスの「nextCursor」または「prevCursor」）の値を指定します。 cursor |
String |
|
|
取得最大件数 - 取得する最大件数を指定します。 limit |
String |
|
