郵便番号・デジタルアドレスAPIは、デジタルアドレスコアシステムへのアクセスを提供します。
トークン発行やデジタルアドレス、郵便番号、事業所個別郵便番号の検索などの機能を提供します。
郵便番号、事業所個別郵便番号、デジタルアドレスの統一検索エンドポイント。
いずれかを指定して検索を行い、住所情報を返す。
テスト用APIではテスト用のデジタルアドレス3種と東京都千代田区に対して郵便番号、事業所個別郵便番号の検索が可能。
検索時に、ページ番号や取得件数を指定。指定がない場合はデフォルト値が適用される。
パラメーター:
page: ページ番号 (デフォルト値:1)limit: 取得する最大レコード数 (デフォルト値:1000、最大値:1000)choikitype: 返却する町域フィールド (指定がない場合はchoikitype=1とみなす)1: 括弧なし2: 括弧ありsearchtype: 検索対象 (指定がない場合はsearchtype=1とみなす)1: 郵便番号、事業所個別郵便番号、デジタルアドレスを検索2: 郵便番号、デジタルアドレスを検索検索可能なデジタルアドレス3種:
サンプル1デジタルアドレス: A7E-2FK2住所： 都道府県: 東京都市区郡町村: 千代田区町名: 丸の内番地: 2丁目7-2建物: 部屋番号:サンプル1サンプル2デジタルアドレス: JN4-LKS2住所： 都道府県: 大阪府市区郡町村: 大阪市北区町名: 梅田番地: 3丁目2-2建物: 部屋番号:サンプル2サンプル3デジタルアドレス: QN6-GQX1住所： 都道府県: 福岡県市区郡町村: 福岡市博多区町名: 博多駅中央街番地: 9-1建物: 部屋番号:サンプル3| search_code required | string
|
| page | number ページ番号 (デフォルト値:1) |
| limit | number 取得最大レコード数 (デフォルト値:1000、最大値:1000) |
| ec_uid | string プロバイダーのユーザーID (クエリパラメーター) |
| choikitype | number 返却するフィールドを指定 (指定がない場合はchoikitype=1とみなす)
|
| searchtype | number 検索方法を指定 (指定がない場合はsearchtype=1とみなす)
|
{- "addresses": [
- {
- "dgacode": null,
- "zip_code": 100492,
- "pref_code": "05",
- "pref_name": "秋田県",
- "pref_kana": null,
- "pref_roma": null,
- "city_code": 5368,
- "city_name": "南秋田郡大潟村",
- "city_kana": null,
- "city_roma": null,
- "town_name": "字西",
- "town_kana": null,
- "town_roma": null,
- "biz_name": "あきたこまち生産者協会",
- "biz_kana": "アキタコマチセイサンシヤキヨウカイ",
- "biz_roma": null,
- "block_name": "４丁目８８",
- "other_name": null,
- "address": null,
- "longitude": null,
- "latitude": null
}, - {
- "dgacode": null,
- "zip_code": 100492,
- "pref_code": "05",
- "pref_name": "秋田県",
- "pref_kana": null,
- "pref_roma": null,
- "city_code": 5368,
- "city_name": "南秋田郡大潟村",
- "city_kana": null,
- "city_roma": null,
- "town_name": "字西",
- "town_kana": null,
- "town_roma": null,
- "biz_name": "あきたこまち生産者協会",
- "biz_kana": "アキタコマチセイサンシヤキヨウカイ",
- "biz_roma": null,
- "block_name": "４丁目８８",
- "other_name": null,
- "address": null,
- "longitude": null,
- "latitude": null
}
], - "searchtype": "bizzipcode",
- "limit": 10,
- "count": 1,
- "page": 1
}住所の一部から該当する郵便番号・住所情報を検索。 テスト用API
| ec_uid | string プロバイダーのユーザーID (クエリパラメーター) |
pageでページ番号を指定し、limitでレスポンスの最大取得件数を指定可能pageとlimitが省略された場合は、デフォルト値 (page=1, limit=1000)が適用されるpref_codeとpref_nameが両方リクエストされた場合は、pref_codeが優先されるcity_codeとcity_nameが両方リクエストされた場合は、city_codeが優先される| pref_code | string 都道府県コード |
| pref_name | string 都道府県名 |
| pref_kana | string 都道府県名カナ |
| pref_roma | string 都道府県名ローマ字 |
| city_code | string 市区町村コード |
| city_name | string 市区町村名 |
| city_kana | string 市区町村名カナ |
| city_roma | string 市区町村名ローマ字 |
| town_name | string 町域 |
| town_kana | string 町域カナ |
| town_roma | string 町域ローマ字 |
| freeword | string フリーワード |
| flg_getcity | number 市区町村一覧のみ取得フラグ (デフォルト値:0、 0:すべての情報を取得、1:市区町村のみの情報を取得) |
| flg_getpref | number 都道府県一覧のみ取得フラグ (デフォルト値:0、0:すべての情報を取得、1:都道府県のみの情報を取得) |
| page | integer ページ数 (デフォルト値:1) |
| limit | integer 取得最大レコード数 (デフォルト値:1000、最大値:1000) |
都道府県コードと市区町村コード
{- "pref_code": "13",
- "city_code": "13102",
- "flg_getcity": 0,
- "flg_getpref": 0,
- "page": 1,
- "limit": 100
}{- "addresses": [
- [
- {
- "zip_code": "1040044",
- "pref_code": "13",
- "pref_name": "東京都",
- "pref_kana": "トウキョウト",
- "pref_roma": "TOKYO",
- "city_code": "13102",
- "city_name": "中央区",
- "city_kana": "チュウオウク",
- "city_roma": "CHUO-KU",
- "town_name": "明石町",
- "town_kana": "アカシチョウ",
- "town_roma": "AKASHICHO"
}, - {
- "zip_code": "1040042",
- "pref_code": "13",
- "pref_name": "東京都",
- "pref_kana": "トウキョウト",
- "pref_roma": "TOKYO",
- "city_code": "13102",
- "city_name": "中央区",
- "city_kana": "チュウオウク",
- "city_roma": "CHUO-KU",
- "town_name": "入船一丁目",
- "town_kana": "イリフネ 1",
- "town_roma": "IRIFUNE 1"
}
], - [
- {
- "zip_code": "1040044",
- "pref_code": "13",
- "pref_name": "東京都",
- "pref_kana": "トウキョウト",
- "pref_roma": "TOKYO",
- "city_code": "13102",
- "city_name": "中央区",
- "city_kana": "チュウオウク",
- "city_roma": "CHUO-KU",
- "town_name": "明石町",
- "town_kana": "アカシチョウ",
- "town_roma": "AKASHICHO"
}, - {
- "zip_code": "1040042",
- "pref_code": "13",
- "pref_name": "東京都",
- "pref_kana": "トウキョウト",
- "pref_roma": "TOKYO",
- "city_code": "13102",
- "city_name": "中央区",
- "city_kana": "チュウオウク",
- "city_roma": "CHUO-KU",
- "town_name": "入船一丁目",
- "town_kana": "イリフネ 1",
- "town_roma": "IRIFUNE 1"
}
]
], - "level": 2,
- "limit": 100,
- "count": 2,
- "page": 1
}OAuth2.0におけるgrant_typeがclient_credentialsに基づいてトークンリクエストに対してAPI利用のトークンを返す。
テスト用APIではgrant_typeおよび事業者登録で事前に取得しているクライアントID(固定)とシークレットキー(固定)を指定してリクエストし、検証結果が問題ない場合はJWT形式のトークンを返却。
| x-forwarded-for required | string 送信元IPアドレス |
| grant_type required | string grant_type (「client_credentials」で固定) |
| client_id required | string クライアントID （固定：テスト用API認証情報画面の"システム情報"参照） |
| secret_key required | string シークレットキー （固定：テスト用API認証情報画面の"システム情報"参照） |
{- "grant_type": "client_credentials",
- "client_id": "TEST7t6fj7eqC5v6UDaHlpvvtesttest",
- "secret_key": "testGzhSdzpZ1muyICtest0123456789"
}{- "scope": "J1",
- "token_type": "Bearer",
- "expires_in": 123456,
- "token": "{アクセストークン}"
}