API docs by Redocly

API Reference for 郵便番号・デジタルアドレス (1.0.0.250319)

Download OpenAPI specification:

郵便番号・デジタルアドレスAPIは、デジタルアドレスコアシステムへのアクセスを提供します。
トークン発行やデジタルアドレス、郵便番号、事業所個別郵便番号の検索などの機能を提供します。

searchcode

郵便番号、事業所個別郵便番号、デジタルアドレスの共通検索

コード番号検索 (1-1029)

郵便番号、事業所個別郵便番号、デジタルアドレスの統一検索エンドポイント。 いずれかを指定して検索を行い、住所情報を返す。
検索時に、ページ番号や取得件数を指定。指定がない場合はデフォルト値が適用される。

パラメーター:

  • page: ページ番号 (デフォルト値:1)
  • limit: 取得する最大レコード数 (デフォルト値:1、最大値:1000)
  • choikitype: 返却する町域フィールド (指定がない場合はchoikitype=1とみなす)
    • 1: 括弧なし
    • 2: 括弧あり
  • searchtype: 検索対象 (指定がない場合はsearchtype=1とみなす)
    • 1: 郵便番号、事業所個別郵便番号、デジタルアドレスを検索
    • 2: 郵便番号、デジタルアドレスを検索
Authorizations:
token
path Parameters
search_code
required
string
  • 郵便番号 (3桁以上の数値。入力された値が7桁未満であった場合、入力値から始まるデータをパターン検索する。)
  • 事業所個別郵便番号
  • デジタルアドレス
query Parameters
page
number

ページ番号 (デフォルト値:1)

limit
number

取得最大レコード数 (デフォルト値:1、最大値:1000)

ec_uid
string

プロバイダーのユーザーID (クエリパラメーター)

choikitype
number

返却するフィールドを指定 (指定がない場合はchoikitype=1とみなす)

  • 1: 括弧無し町域フィールド
  • 2: 括弧有り町域フィールド
searchtype
number

検索方法を指定 (指定がない場合はsearchtype=1とみなす)

  • 1: 郵便番号、事業所個別郵便番号、デジタルアドレスを検索する
  • 2: 郵便番号、デジタルアドレスを検索する (事業所個別郵便番号は検索対象外)

Responses

Response samples

Content type
application/json
{
  • "addresses": [
    ],
  • "searchtype": "bizzipcode",
  • "limit": 10,
  • "count": 1,
  • "page": 1
}

addresszip

住所の一部から該当する住所を検索

住所から郵便番号を検索 (1-1018/1-1019)

住所の一部から該当する郵便番号・住所情報を検索

Authorizations:
token
query Parameters
ec_uid
string

プロバイダーのユーザーID (クエリパラメーター)

Request Body schema: application/json
required
  • 住所から該当する郵便番号を返す
  • マッチングレベルに応じたデータを返す
  • リクエストのデータタイプを添えてリクエストすること。データタイプは下記が該当
    • コード (pref_codeなど)
    • 名称 (pref_nameなど)
    • カタカナ
    • ローマ字
    • フリーワード
  • パラメータについての注意
    • 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)

Responses

Request samples

Content type
application/json
Example

都道府県コードと市区町村コード

{
  • "pref_code": "13",
  • "city_code": "13102",
  • "flg_getcity": 0,
  • "flg_getpref": 0,
  • "page": 1,
  • "limit": 100
}

Response samples

Content type
application/json
{
  • "addresses": [
    ],
  • "level": 2,
  • "limit": 100,
  • "count": 2,
  • "page": 1
}

token

事業者が郵便番号・デジタルアドレスAPIを利用するのに必要なトークンを取得

API利用トークンの取得 (1-1028)

OAuth2.0におけるgrant_typeがclient_credentialsに基づいてトークンリクエストに対してAPI利用のトークンを返す。
grant_typeとともに、組織およびシステム登録で事前に取得しているクライアントIDとシークレットキーを指定してリクエストし、検証結果が問題ない場合はJWT形式のトークンを返却。

header Parameters
x-forwarded-for
required
string

送信元IPアドレス

Request Body schema: application/json
required
grant_type
required
string

grant_type (「client_credentials」で固定)

client_id
required
string

クライアントID

secret_key
required
string

シークレットキー

Responses

Request samples

Content type
application/json
{
  • "grant_type": "client_credentials",
  • "client_id": "TEST7t6fj7eqC5v6UDaHlpvvtesttest",
  • "secret_key": "testGzhSdzpZ1muyICtest0123456789"
}

Response samples

Content type
application/json
{
  • "scope": "J1",
  • "token_type": "Bearer",
  • "expires_in": 123456,
  • "token": "{アクセストークン}"
}