アドオンの概要

 「郵便番号・デジタルアドレスAPI Add-on」は、日本郵便株式会社が提供する「郵便番号・デジタルアドレス for Biz」のサービスラインアップの1つである「郵便番号・デジタルアドレス API」を、API のシステム情報を入力するだけで使用できるようになるアドオンです。

デジタルアドレスとは

 郵便番号・デジタルアドレス API では、郵便番号を用いた住所検索の他に、2025年5月26日から開始した「デジタルアドレス」を用いて住所を検索できることが特徴です。

 デジタルアドレスとは、7桁の英数字によって利用者の住所を特定することができる、新しい仕組みです。あくまでデジタルアドレスと利用者を紐づける仕組みなので、引越しなどで住所の変更があった場合でも、デジタルアドレスの管理画面から住所を変更することで、7桁の英数字はそのままに、新しい住所を特定することが可能です。

 デジタルアドレスを利用するには デジタルアドレス のWebサイトで利用者登録、および住所の登録をする必要があります。デジタルアドレスについてや、利用上の注意点、使える場所やサービスなどを含め、詳細はこちらの Webサイトをご覧ください。

郵便番号・デジタルアドレス API の利用開始手続き

郵便番号・デジタルアドレス for Biz のアカウント作成

 郵便番号・デジタルアドレスAPI Add-on を利用するには、まず 郵便番号・デジタルアドレス for Biz のアカウントを作成する必要があります。

  1. まずは [新規登録] を押して次の画面に進みます。
  1. 次に「ゆうID」を持っていなければ、ゆうID の新規登録を行います。
  1. ゆうID の利用規約が表示されるので、内容を確認した上で問題がなければ、同意欄すべてにチェックをし、次へ進みます。
  1. 仮登録画面が表示されるので、メールアドレスを入力し、仮登録をします。
  1. 4 で入力したメールアドレス宛に仮登録完了のメールが届くので、記載されている URL から本登録画面に移り、パスワードの入力をして次へ進みます。
  1. お客様情報の入力を行い、必須項目を埋めたら次へ進みます。
  1. 登録が完了したらログイン画面に進みます。
  1. ゆうIDの登録の際に指定したメールアドレスとパスワードを入力し、サービスにログインします。
  1. 一旦 2 と同じ画面に移るので、次はこの画面で [ゆうID] でログインを行います。
  1. 郵便番号・デジタルアドレス for Biz の利用規約が表示されるので、内容を確認した上で、問題がなければ同意欄にチェックをし、次へ進みます。
  1. ユーザー名を入力し、アカウントの登録を行います。
  1. 組織登録画面が表示されるので、アカウントのユーザーが所属する組織の情報を入力し、登録を行います。
  1. これで郵便番号・デジタルアドレス for Biz のアカウント登録は完了です。

API 利用のためのシステムの登録

  1. [サービス] -> [郵便番号・デジタルアドレスAPI] -> [システムリスト] で表示される画面で、[新規登録] を選択します。
  1. システム登録に必要な情報を入力し、登録を行います。
  1. 登録が完了すると、API を利用するのに必要な [クライアントシークレット], [クライアントID], 入力した利用システムの固定 [IPアドレス] が表示されます。この3つは API を利用するにあたって必要な項目です。特に、クライアントシークレットはこの画面以外では確認できないので、必ず手元に控えてください。確認を終えたら、システムリストに戻ってOKです。

郵便番号・デジタルアドレスAPI Add-on の初期設定

 API 利用のためのシステムの登録時に入力・取得した [IPアドレス], [クライアントID], [クライアントシークレット] をアドオンの初期設定画面で入力します。初期設定はこれで完了です。

住所を設定するフィールドの変更方法

 スクリプト:[郵API]郵便番号から住所を検索 を開きます。113〜120行目に住所をフィールドへ設定している箇所があるので、必要に応じて変更してください。