クイックスタート

Step 1 / 5 — アカウントを作るこの見出しへのリンク

ケンオールのサインアップページでメールアドレスとパスワードを登録し、確認メールのリンクをクリック。フリープランは無料・カード登録不要で始められます。

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

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

登録手順やメール認証 (確認メール) について詳しくは、ヘルプの 新規登録 を参照してください。

Step 2 / 5 — APIキーを取得してコピーするこの見出しへのリンク

ログイン後、ダッシュボードの左メニュー「APIキー」を開くと、APIキー管理画面が表示されます。やることは ① キーをコピー と、ブラウザから直接呼ぶ場合は ② 許可ドメインを登録 の2つだけです。

ダッシュボードの「APIキーの管理」画面では、各APIキーについて「名前・APIキー・有効期限・許可ドメイン」が一覧表示されます。

1. APIキー: キー欄をクリックでコピー。これが次の手順の YOUR_API_KEY です。
2. ドメインとポート番号を登録 (ブラウザから直接呼ぶ場合のみ必要)。

Step 3 / 5 — curlで叩くこの見出しへのリンク

ターミナルで以下を実行します (YOUR_API_KEY を Step 2 でコピーした値に置き換え)。

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

これは千代田 (皇居周辺) の郵便番号 (〒100-0001) を引いています。

Step 4 / 5 — レスポンスを確認するこの見出しへのリンク

下のようなJSON (データのフォーマット) が返れば成功です。

{
  "version": "2021-06-30",
  "data": [
    {
      "postal_code": "1000001",
      "prefecture": "東京都",
      "city": "千代田区",
      "town": "千代田"
    }
  ]
}

data が配列なのは、1つの郵便番号に複数住所が紐づくケースがあるためです。

他にも試せる郵便番号この見出しへのリンク

ケンオールの最大の特徴の一つは高精度なデータです。都道府県・市区町村・町名だけでなく、丁目や小字、京都の通り名やビル名なども出力できます。Step 3 の郵便番号を以下に差し替えて、違いを試してみてください。

• 丁目を含む例 — 0482331
• 小字を含む例 — 0893443
• 地割を含む例 — 0282504
• 京都の通り名を含む例 — 6048012
• ビル名と階層を含む例 — 1046001
• 大口事業所個別番号の例 — 1008926

Step 5 / 5 — もし、ご自身の環境で動かすならこの見出しへのリンク

ここまでで API は動いています。あとは、ご自身のサイト・アプリ・バッチ処理に組み込むだけです。主な方法は次の2つです。

1. 公式SDKを使う — JavaScript SDK (Node.js・ブラウザ対応) と Python SDK を提供しています。APIキーを渡すだけで、認証ヘッダの組み立てやレスポンスの取り扱いを SDK に任せられます。
2. HTTPクライアントで直接呼ぶ — SDK のない言語でも、Authorization: Token YOUR_API_KEY ヘッダを付けて Step 3 と同じエンドポイントにリクエストするだけです。共通仕様は API共通仕様、各APIの詳細は APIリファレンス を参照してください。

Step 3 で試した curl コマンドと、返ってくる JSON の形が、そのまま実装の雛形になります。

ブラウザ・React で動かすこの見出しへのリンク

ケンオールでは公式のJavaScript SDKを提供しており、ブラウザから直接ケンオールを組み込めます。kenall-jsを使ったReactのデモアプリや、実際に動作しているデモサイトも公開しているので、React で開発するときの参考にしてください。

次に読むこの見出しへのリンク

• 郵便番号→住所API のフル仕様
• API共通仕様 (認証・HTTPステータス・エラー)
• JavaScript SDK / Python SDK で実装する

最終更新: 2026-07-14