Skip to main content

ダウンロードAPI

GET /download/postalcode/#

info

本APIは、エンタープライズプランご購入のお客様のみが利用できます。

caution

本APIは、シークレットキーでのみ利用できます。公開キーでは利用できませんのでご注意ください。

APIキーの管理の詳細についてはAPIキーの管理を参照してください。

ダウンロード可能な郵便番号データのリソース一覧を取得します。

リソースURL#

https://api.kenall.jp/v1/download/postalcode/

パラメータ#

なし

レスポンス#

以下はレスポンスの一例です。

{  "json": [    "latest/kenall.json.xz",    "2021-06-30/kenall.json.xz"  ]}

レスポンスのデータは以下のような構成になっています。

名前説明
jsonarrayjson形式としてダウンロード可能な郵便番号データファイルパスの一覧["latest/kenall.json.xz","2021-06-30/kenall.json.xz"]

ダウンロードファイルパスの形式#

ダウンロードファイルパスは、<バージョン>/<ファイル名>というフォーマットで構成されています。

バージョンlatestは特殊なバージョン表記で、リスト内の最新のバージョンを参照します。

GET /download/postalcode/:ダウンロードファイルパス#

info

本APIは、エンタープライズプランご購入のお客様のみが利用できます。

caution

本APIは、シークレットキーでのみ利用できます。公開キーでは利用できませんのでご注意ください。

APIキーの管理の詳細についてはAPIキーの管理を参照してください。

指定したファイルパスのダウンロード用URLを取得し、リダイレクトします。

リソースURL#

https://api.kenall.jp/v1/download/postalcode/:ダウンロードファイルパス

パラメータ#

名前必須かどうか説明
ダウンロードファイルパスstring必須ダウンロード対象のファイルパス。入力文字列は、GET /download/postalcode/で取得できる一覧に含まれている必要があります。https://api.kenall.jp/v1/download/postalcode/latest/kenall.json.xz

レスポンス#

成功した場合、レスポンスのステータスコードが303となります。

レスポンスヘッダーには以下が含まれます。

Location: <ダウンロードURL>

このダウンロードURLは、一時的に有効なURLとなっており、再利用はできません。

ダウンロードするたびに、必ず本APIを通して再取得してください。

ダウンロードファイルについて#

データはjson形式となっていて、郵便番号検索APIと同様のフォーマットになっています。

詳細なフォーマットについては、郵便番号検索APIのレスポンスを参照してください。

ダウンロードしたデータはxz形式で圧縮されています。