Skip to main content

スタートガイド

まずはAPIを試してみる

ケンオールを試すだけなら、ユーザ登録やログインの必要はありません!

まずは郵便番号APIデモを試してみましょう。

ケンオールの最大の特徴の一つは、高精度なデータを提供していることです。都道府県・市区町村・町名だけでなく、丁目や小字、京都の通り名やビル名なども出力することができます。

以下の郵便番号を試してみましょう。

  • 標準的な郵便番号の例(都道府県、市区町村、町名)
    • 1000001
  • 丁目・小字を含む例
    • 丁目を含む例
      • 0482331
    • 小字を含む例
      • 0893443
    • 地割を含む例
      • 0282504
  • 京都の通り名を含む例
    • 6048012
  • ビル名と階層を含む例
    • 1046001
  • 個別事業所番号の例
    • 1008926

ケンオールを開発環境で実際に試してみたい場合は、ユーザー登録をして、ケンオールAPIにアクセスできるようにしましょう!

新規登録

新規登録ページから、アカウントを新規登録します。

新規登録

メールアドレスとパスワードを設定します。

パスワードポリシーは以下の通りです。

  • 最低9文字以上、文字数上限なし
  • ある程度複雑なパスワードであること
  • 数字のみのパスワードは不可、利用文字に制限なし

設定が完了したら、利用規約とプライバシーポリシーを確認の後、 利用規約に同意して登録 ボタンを押してください。

登録したメールアドレスに確認メールが送信されます。メールを開き、指示の通りにリンクをクリックし、登録を完了してください。

メールアドレス確認

メールに記載された確認URLを開くと、アカウントの登録処理が完了します。 ログインする リンクを押してください。

アカウント登録完了

ログイン画面から、さきほど登録したメールアドレスとパスワードを入力し、 ログイン ボタンを押します。

ログイン画面

APIキーを取得する

ログインすると、ダッシュボードが表示されます。

ダッシュボード

ダッシュボードに記載されているAPIキーを使うことで、ケンオールAPIにアクセスすることができるようになります。

APIキーを使うことで、お客様のアカウントとしてケンオールAPIにアクセスすることができます。取り扱いには十分ご注意ください。

公開キーの右の文字列をクリックすることで、クリップボードにコピーすることができます。

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

ブラウザから直接APIを実行するには、リクエスト元のドメインを許可する必要があります。設定方法については、リクエストを許可するドメインを設定するを参照してください。

APIを試してみる

取得したAPIキーを使って、APIを試しに使ってみましょう。

郵便番号検索API

まずは基本のAPIである、郵便番号検索APIを試してみましょう。

このAPIは、指定した郵便番号に対応する住所エリア(郵便区画と言います)の住所情報を返します。

Linux / Mac ならターミナル、Windows ならコマンドプロンプトを開いて、以下のコマンドを実行してみてください。

curl -H "Authorization: Token $YOUR_API_KEY" "https://api.kenall.jp/v1/postalcode/1000000"

ここで $YOUR_API_KEY は、先程取得したAPIキーです。

成功すれば、以下のような結果が返ってきます。(見やすくするため、整形しています)

{
"version": "2020-11-30",
"data": [
{
"jisx0402": "13101",
"old_code": "100",
"postal_code": "1000000",
"prefecture_kana": "トウキョウト",
"city_kana": "チヨダク",
"town_kana": "",
"town_kana_raw": "イカニケイサイガナイバアイ",
"prefecture": "東京都",
"city": "千代田区",
"town": "",
"koaza": "",
"kyoto_street": "",
"building": "",
"floor": "",
"town_partial": false,
"town_addressed_koaza": false,
"town_chome": false,
"town_multi": false,
"town_raw": "以下に掲載がない場合",
"corporation": null
}
]

data 以下には、入力した郵便番号に対応する郵便区画レコードの配列が入っています。

1つの郵便番号には複数の郵便区画レコードが含まれる場合があるため、レスポンスデータは配列になります。

FAQも参照してください。

レスポンスデータの詳細はAPIリファレンスを参照してください。

郵便番号逆引き検索API

ケンオールでは、住所から郵便番号を検索することもできます。

以下のコマンドを実行してみてください。

curl -H "Authorization: Token $YOUR_API_KEY" \
"https://api.kenall.jp/v1/postalcode/?t=東京都千代田区麹町三丁目12-14麹町駅前ヒルトップ8F&limit=1"

これは、「東京都千代田区麹町三丁目12-14麹町駅前ヒルトップ8Fに対応する郵便番号を1件だけ検索する」という意味です。

成功すれば、以下のような結果が返ってきます。

{
"version": "2022-01-31",
"data": [
{
"jisx0402": "13101",
"old_code": "102",
"postal_code": "1020083",
"prefecture_kana": "トウキョウト",
"city_kana": "チヨダク",
"town_kana": "コウジマチ",
"town_kana_raw": "コウジマチ",
"prefecture": "東京都",
"city": "千代田区",
"town": "麹町",
"koaza": "",
"kyoto_street": "",
"building": "",
"floor": "",
"town_partial": false,
"town_addressed_koaza": false,
"town_chome": true,
"town_multi": false,
"town_raw": "麹町",
"corporation": null
}
],
"query": {
"raw": "東京都千代田区麹町三丁目12-14麹町駅前ヒルトップ8F",
"prefecture": "東京都",
"county": "",
"city": "千代田区",
"city_ward": "",
"town": "麹町",
"kyoto_street": "",
"block_lot_num": "3-12-14",
"building": "麹町駅前ヒルトップ",
"floor_room": "8F"
},
"count": 61,
"offset": 0,
"limit": 1,
"facets": null
}

dataの中身は郵便番号検索APIと同様、郵便区画レコードの配列が入っています。

検索対象の郵便番号は、郵便区画レコードのpostal_codeに格納されています。

住所正規化

ケンオールでは、入力した住所を要素ごとに分解し、数字等の表記を整理する機能も提供しています。 ケンオールではこの処理を住所正規化と呼んでいます。

この機能は、郵便番号逆引き検索APIの一部として提供されています。

先程の郵便番号逆引き検索APIのレスポンスには、queryというデータも含まれています。

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

入力した文字列と同じものがrawに入っています。

その後、住所文字列を都道府県 政令指定都市行政区 京都の通り名 番地 ビル 階層・部屋番号に分解した結果が入ります。

番地については、表記方法がバラバラなので、整理した形で出力しています。上の例では三丁目12-14で検索していましたが、出力結果は3-12-14となっています。

レスポンスデータの詳細はAPIリファレンスを参照してください。

法人番号API

ケンオールでは、法人名から法人番号や法人の住所などの情報を検索することもできます。

以下のコマンドを実行してみてください。

 curl -H "Authorization: Token $YOUR_API_KEY" \
"https://api.kenall.jp/v1/houjinbangou?q=オープンコレクター&limit=1"

これは、「オープンコレクターを法人名に含む法人情報を1件だけ検索する」という意味です。

成功すれば、以下のような結果が返ってきます。

{
"version": "2022-02-07",
"data": [
{
"published_date": "2022-01-31",
"sequence_number": "1409569",
"corporate_number": "2021001052596",
"process": "12",
"correct": "0",
"update_date": "2021-01-12",
"change_date": "2021-01-04",
"name": "株式会社オープンコレクター",
"name_image_id": null,
"kind": "301",
"prefecture_name": "東京都",
"city_name": "千代田区",
"street_number": "麹町3丁目12-14麹町駅前ヒルトップ8階",
"town": "麹町",
"kyoto_street": null,
"block_lot_num": "3-12-14",
"building": "麹町駅前ヒルトップ",
"floor_room": "8階",
"address_image_id": null,
"jisx0402": "13101",
"post_code": "1020083",
"address_outside": "",
"address_outside_image_id": null,
"close_date": null,
"close_cause": null,
"successor_corporate_number": null,
"change_cause": "",
"assignment_date": "2015-10-05",
"en_name": "",
"en_prefecture_name": "Tokyo",
"en_address_line": "",
"en_address_outside": "",
"furigana": "オープンコレクター",
"hihyoji": "0"
}
],
"query": "オープンコレクター",
"count": 1,
"offset": 0,
"limit": 1,
"facets": null
}

dataの中には、法人番号や正式な法人名、法人住所などを含む法人情報レコードが配列として入っています。

レスポンスデータの詳細はAPIリファレンスを参照してください。

ブラウザで実行する

リクエストを許可するドメインを設定する

住所入力フォームなどでケンオールを利用する場合、APIキーをそのままソースコードに含めてしまうと、誰でも利用できてしまいます。そこで、ケンオールではCORS(オリジン間リソース共有)の仕組みを使って、お客様のサイト経由のリクエストのみケンオールに対するアクセスを許可することができます。

CORSについて詳しくは、以下のページを参照してください。

https://developer.mozilla.org/ja/docs/Web/HTTP/CORS

リクエストを許可するドメインの設定は、アカウント設定Originヘッダー設定から行うことができます。

まず、リクエストを許可するドメイン名を入力してください。複数のドメインを許可する場合はカンマ区切りで入力してください。ドメイン名は、完全一致である必要があります。

caution

Originヘッダー設定には、ドメイン名のみを入力してください。例えば、 example.com を設定したい場合、 https://example.com という表記は利用しないでください。

caution

Originヘッダーに設定するドメイン名には、ワイルドカードを使用することはできません。例えば、 **.example.com という表記は利用できません。

入力したら、変更する ボタンをクリックしてください。

JavaScript SDKを使う

ケンオールでは公式のJavaScript SDKを提供しています。 このSDKを使えば、ケンオールを簡単に自分のサービスに組みこむことができます。

kenall-jsを使ったReactのデモアプリも公開しています。 Reactで開発するときの参考にしてください。

デモアプリを実際に動作させているサイトもありますので、こちらも参考にしてみてください。