重要なお知らせ吸収分割公告 — ケンオール事業の権利義務承継についてお知らせ一覧 →

JavaScript SDK

要約: ケンオール公式 JavaScript SDK は npm パッケージ @ken-all/kenall として提供。Node.js とブラウザ両対応、Promise ベースで全API (郵便番号・法人番号・銀行・祝日 等) を直感的に呼び出せます。

インストール方法は？この見出しへのリンク

npm からインストールできます:

npm i @ken-all/kenall

yarn / pnpm を使う場合:

yarn add @ken-all/kenall
# または
pnpm add @ken-all/kenall

どのランタイムで動きますか？この見出しへのリンク

  • Node.js (require での読み込みに対応)
  • ブラウザ (スタンドアロンJavaScriptバンドル経由)
情報

Node.js は 20 以上が必要です。 グローバルな Fetch API を利用するため、Node.js 20 未満のランタイムでは動作しません。

Node.js での使い方この見出しへのリンク

APIキーをコンストラクタに渡してクライアントを作るだけです。

const { KENALL } = require('@ken-all/kenall');
 
const api = new KENALL('YOUR_API_KEY');
 
api.getAddress('1000001').then(
  r => { console.log(r); }
).catch(
  e => { console.error(e); }
);

ESM (import形式) を使う場合:

import { KENALL } from '@ken-all/kenall';
 
const api = new KENALL('YOUR_API_KEY');
 
try {
  const result = await api.getAddress('1000001');
  console.log(result);
} catch (e) {
  console.error(e);
}

ブラウザでの使い方この見出しへのリンク

HTML に SDK バンドルを読み込んだあと、グローバル kenall.KENALL から利用します。バンドルは事前にブラウザからアクセス可能な場所にアップロードしておく必要があります。

<!-- HTMLに読み込む (最新バンドルURL) -->
<script src="https://js.kenall.jp/2026-05-11/kenall.js"></script>
 
<script>
function fill(form) {
  const k = new kenall.KENALL('YOUR_API_KEY');
  const postalCode = form.elements["postalcode"].value;
  k.getAddress(postalCode).then(
    function (address) {
      const firstCandidate = address.data[0];
      form.elements["prefecture"].value = firstCandidate["prefecture"];
      form.elements["city"].value = firstCandidate["city"];
      form.elements["town"].value = firstCandidate["town"];
    }
  ).catch(function () {
    alert("API呼び出しに失敗しました");
  });
}
</script>
情報

ブラウザから直接利用する場合は公開キーを使用してください。 公開キーはクライアントに配置される前提のキーです。ダッシュボードで許可ドメインを登録すると Origin ヘッダーで利用元が制限され、許可ドメイン以外からのリクエストは拒否されるため、値がブラウザに現れても差し支えありません。サーバーサイドで利用する場合や秘匿が必要な処理にはシークレットキーを使用し、サーバー内に厳重に保管してください。

対応しているAPIは？この見出しへのリンク

JavaScript SDK は以下のすべてのケンオールAPIに対応しています:

エラーハンドリングは？この見出しへのリンク

Promise ベースなので、.catch() または try/catch(async/await時) で例外を捕捉できます。

api.getAddress('1000001')
  .then((result) => {
    // 成功時のレスポンス処理
    console.log(result.data[0].prefecture);
  })
  .catch((err) => {
    // 401 (APIキー無効) / 404 (該当なし) / 429 (レート制限) 等
    console.error('API error:', err);
  });

関連リンクこの見出しへのリンク

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

最終更新: 2026-07-17