リリース一周年とアップデートのお知らせ

ケンオールは2022年2月8日でリリースから一周年になりました。 いつもご利用いただいているユーザーの皆様、本当にありがとうございます。

この一周年という節目に、ケンオールは大きな機能追加を実施いたします。 変更予定日は2/21(月)となります。

重要 ケンオールユーザーはシステム側の対応が必要となりますので本記事をご一読ください。同様の案内をメールでも送付させていただいております。

郵便番号逆引きAPI(正式版)

2021年5月にベータリリースした郵便番号逆引きAPIを正式版としてリリースします。 郵便番号逆引きAPIは、住所から郵便番号を検索する機能を提供するAPIです。

正式版では、以下の機能が追加されています。

  • フリーテキスト検索
  • 住所正規化

郵便番号逆引きAPIは、新プランの「郵便番号APIプラス」でご利用いただけます。

法人番号APIプランをご購読のお客様は、郵便番号APIプラスの全ての機能をご利用いただけます。

フリーテキスト検索

ベータ版では東京都 千代田区 麴町のようにユーザーが自分で住所要素(都道府県、市区町村など)ごとにスペースで区切らなければいけませんでした。 また、3丁目12-14麹町駅前ヒルトップ8階のような番地やビル名の情報が入っているとうまく検索できないという問題がありました。

正式版では東京都千代田区麹町3丁目12-14麹町駅前ヒルトップ8階と文字列をそのまま入力するだけで検索できます。

https://api.kenall.jp/v1/postalcode/?t=東京都千代田区麹町3丁目12-14麹町駅前ヒルトップ8階

実行すると、以下のようなレスポンスが返ります。(一部のみ表示)

{
  "version": "2021-12-28",
  "data": [
    {
      ...
      "postal_code": "1020083",
      ...
      "prefecture": "東京都",
      "city": "千代田区",
      "town": "麹町",
      ...
    },
    ...
   ],
 ...
}

住所正規化

フリーテキスト検索で入力した住所を住所要素ごとに分割して出力します。 例えば、東京都千代田区麹町3丁目12-14麹町駅前ヒルトップ8階と入力すると、以下のように分割します。

  • 都道府県 東京都
  • 市区町村千代田区
  • 町名 麴町
  • 丁目・番地 3-12-14
  • ビル名 麹町駅前ヒルトップ
  • 階層・部屋番号 8階

分割するだけでなく、丁目・番地については「半角数字・ハイフン区切り」に整形しています。例えば、以下の丁目・番地文字列は全て同じ結果3-12-14を出力します。

  • 3丁目12-14
  • 3丁目12番14号
  • 3-12番地14

実際のレスポンス例は以下の通りです。qtは検索時に入力されたクエリ文字列です。

  "query": {
    "q": null,
    "t": "東京都千代田区麹町3丁目12-14麹町駅前ヒルトップ8階",
    "prefecture": "東京都",
    "county": null,
    "city": "千代田区",
    "city_ward": null,
    "town": "麹町",
    "kyoto_street": null,
    "block_lot_num": "3-12-14",
    "building": "麹町駅前ヒルトップ",
    "floor_room": "8階"
  }

法人番号API: 法人住所の住所要素分割フィールドを追加

従来の法人番号APIでは、法人番号データに記載されている住所データをそのまま出力していました。 法人番号データでは、町名以下の住所は1つのフィールドに格納されています。

{
      ...
      "prefecture_name": "東京都",
      "city_name": "千代田区",
      "street_number": "麹町3丁目12-14麹町駅前ヒルトップ8階",
      ...
}

しかし、住所フォームで住所補完UIを作成する際に、ビル名以下が分割されていないと不便だという要望をお客様からいただきました。 そこで、住所フィールドを「町名」「京都の通り名」「号番地」「ビル名」「階層・部屋番号」の5つの住所要素に分割するように変更しました。

以下は、法人番号APIのレスポンスの例です。(一部のみ表示)

{
      ...
      "prefecture_name": "東京都",
      "city_name": "千代田区",
      "street_number": "麹町3丁目12-14麹町駅前ヒルトップ8階",
      "town": "麹町",
      "kyoto_street": null,
      "block_lot_num": "3-12-14",
      "building": "麹町駅前ヒルトップ",
      "floor_room": "8階",
      ...
}

郵便番号API: 個別事業所番号の住所要素分割フィールドを追加

個別事業所番号データには丁目・番地以下を格納するblock_lotというフィールドが存在します。

        "block_lot": "2丁目8-1",

このフィールドに対しても正規化処理を行い、住所要素に分割して出力するようにしました。 例えば、上記住所は新たに追加されたblock_lot_numというフィールドで以下のように正規化されます。

        "block_lot": "2丁目8-1",
        "block_lot_num": "2-8-1",

リリースのスケジュールとシステム対応のお願い

このアップデートは2/21(月)に実施予定です。

ケンオールユーザーの皆様は以下の対応をお願いいたします。

APIに対して直接リクエストしている場合、あるいは内製クライアントライブラリを開発している場合

APIのレスポンスに追加されるフィールドを問題なく受け付けることができるかどうか、ご自身のシステムあるいはライブラリをご確認ください。 既存のフィールドに変更はありません。

公式JavaScript SDK kenall-js をご利用されている場合

公式 JavaScript SDK kenall-jsをご利用の場合は、既にリリース済みの kenall-js 1.6.0以上にアップグレードをお願いいたします。

ケンオールについて

「かゆいところにケンオール」 ケンオールは、郵便番号住所検索APIをはじめとした、システム開発を加速する高品質で安全なAPIサービスです。 サービスを試してみたい方はこちらから: kenall.jp

Shodoで執筆されました