製品を選ぶ
REST API
Address Search API
郵便番号・住所データを、自社のUIやバックエンドから検索する
技術ドキュメントを読む →Web Component
Address Selector
住所を検索・選択するUIをWebプロダクトへ組み込む
技術ドキュメントを読む →Hosted JavaScript
Address AutoComplete JavaScript
既存フォームを郵便番号から補完する
技術ドキュメントを読む →REST API
Address Parser
自由形式の日本語住所を構造化する
技術ドキュメントを読む →製品ごとに使うキー
REST APIと住所補完ではAPI Key、住所選択WidgetではPublic Clientから取得するPublic Keyを使います。
| 製品 | 使用する認証情報 | 主な利用場所 | 利用元の制限 |
|---|---|---|---|
| Address Search API | API Key | Browser / Server | HTTP Referer / IP・CIDR |
| Address AutoComplete JavaScript | API Key | Browser | HTTP Referer |
| Address Selector | Public Key | Browser | Origin |
| Address Parser | API Key | API client | API Keyに設定した制限 |
API KeyとPublic Keyは別の認証情報です
Address Selectorのpublic-key属性へAPI Keyを設定しても利用できません。Public KeyをAddress Search APIやAddress Parserのapikey headerへ設定しないでください。
API Keyの準備方法とPublic Clientの準備方法を確認してから実装してください。
実装を始める
柔軟な住所検索
filterは自由文検索ではなく、field・operator・valueを組み合わせる条件式です。
エラーと再試行
認証、利用制限、0件、429、5xxを分け、再試行できる条件と待機時間を確認します。
エラーガイドへ →実際のレスポンスを確認する
Address Selector、Address Search API、Address AutoComplete JavaScriptはPlaygroundでも確認できます。
従来ドキュメントとの関係
従来のAPI・JavaScriptドキュメントは、旧バージョンとの互換性確認のため継続提供しています。新規実装では、このサイトの製品別ドキュメントを利用してください。