認証API

• ユーザ認証・アプリケーション認可
• ユーザーの検索

住所録連携API

• 郵便番号辞書
• リソースエンドポイントURL
• 都道府県取得
• 市区町村取得
• 郵便番号取得
• 郵便番号検索
• グループ(住所録)
• 住所
• 自宅住所
• バッチ処理
• レコードの受信

郵便番号辞書

リソースエンドポイントURL

Production

https://account.fudemame.jp/api/

Staging

http://account-stg.fudemame.jp/api/

都道府県取得

都道府県の一覧を取得します。

Request

GET /zipcode/prefs/all
Authorization: Bearer ACCESS_TOKEN
...

Response

HTTP/1.1 200 OK
...
[
    {"code":"01","name":"\u5317\u6d77\u9053","kana":"\uff8e\uff6f\uff76\uff72\uff84\uff9e\uff73"},
    {"code":"02","name":"\u9752\u68ee\u770c","kana":"\uff71\uff75\uff93\uff98\uff79\uff9d"},
    ...
    {"code":"47","name":"\u6c96\u7e04\u770c","kana":"\uff75\uff77\uff85\uff9c\uff79\uff9d"}
]

市区町村取得

指定した都道府県内の市区町村一覧を取得します。

Request

GET /zipcode/munics/[pref_code]
Authorization: Bearer ACCESS_TOKEN
...

Response

HTTP/1.1 200 OK
...
[
    {"pcode":"01","kana":"\uff71\uff6f\uff79\uff7c\uff78\uff9e\uff9d\uff71\uff6f\uff79\uff7c\uff81\uff6e\uff73","name":"\u539a\u5cb8\u90e1\u539a\u5cb8\u753a","mcode":"662"},
    {"pcode":"01","kana":"\uff71\uff6f\uff79\uff7c\uff78\uff9e\uff9d\uff8a\uff8f\uff85\uff76\uff81\uff6e\uff73","name":"\u539a\u5cb8\u90e1\u6d5c\u4e2d\u753a","mcode":"663"},
    ...
    {"pcode":"01","kana":"\uff9c\uff6f\uff76\uff85\uff72\uff7c","name":"\u7a1a\u5185\u5e02","mcode":"214"}
]

郵便番号取得

指定した市区町村内の郵便番号一覧を取得します。

Request

GET /zipcode/list/[pref_code][munic_code]
Authorization: Bearer ACCESS_TOKEN
...

Response

HTTP/1.1 200 OK
...
[
    {"kana":"","zipcode":"0851200","name":""},
    {"kana":"\uff71\uff84\uff7a\uff7c\uff6c\uff97\uff76","zipcode":"0851146","name":"\u30a2\u30c8\u30b3\u30b7\u30e4\u30e9\u30ab"},
    ...
    {"kana":"\uff93\uff8e\uff9b\uff9b","zipcode":"0851134","name":"\u8302\u5e4c\u5442"}
]

郵便番号検索

指定した郵便番号に前方一致する郵便番号一覧を取得します。

Request

GET /zipcode/find/[zipcode]
Authorization: Bearer ACCESS_TOKEN
...

Response

HTTP/1.1 200 OK
...

[
    {
        "name":["\u6771\u4eac\u90fd","\u5343\u4ee3\u7530\u533a",""],
        "zip":"1000000",
        "kana":["\uff84\uff73\uff77\uff6e\uff73\uff84","\uff81\uff96\uff80\uff9e\uff78",""]
    },
    {
        "name":["\u6771\u4eac\u90fd","\u5343\u4ee3\u7530\u533a","\u5343\u4ee3\u7530"],
        "zip":"1000001",
        "kana":["\uff84\uff73\uff77\uff6e\uff73\uff84","\uff81\uff96\uff80\uff9e\uff78","\uff81\uff96\uff80\uff9e"]
    },
    ...
    {
        "name":["\u6771\u4eac\u90fd","\u5343\u4ee3\u7530\u533a","\u4e38\u306e\u5185\uff2a\uff30\u30bf\u30ef\u30fc\u5730\u968e\u30fb\u968e\u5c64\u4e0d\u660e"],
        "zip":"1007090",
        "kana":["\uff84\uff73\uff77\uff6e\uff73\uff84","\uff81\uff96\uff80\uff9e\uff78","\uff8f\uff99\uff89\uff73\uff81\uff7c\uff9e\uff6a\uff72\uff8b\uff9f\uff70\uff80\uff9c\uff70\uff81\uff76\uff72\uff65\uff76\uff72\uff7f\uff73\uff8c\uff92\uff72"]
    }
]