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エンドポイントは一つだけ、 /postalcode/{郵便番号} です。

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    }  ]

ブラウザで実行する#

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

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

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

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

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

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

caution

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

caution

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

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