Yahoo! ID連携

請求先住所参照API(BillingAddressAPI)

請求先住所参照API(BillingAddressAPI)

BillingAddress APIは、Yahoo!ウォレットに登録されているユーザーの住所情報を取得できる属性情報取得APIです。ユーザーがYahoo!ウォレットに登録されていない場合、Yahoo! Japan IDに登録されている住所情報を返却します。
BillingAddress APIにリクエストを送るためには利用申請が必要です。Yahoo!ウォレット FastPayのこちらを参照いただき、ステップにそって導入ください。
ウェブAPI共通で利用するアクセストークンのリクエスト方法およびエラーレスポンスの仕様については、APIアクセス実装方法を参照してください。



リクエスト

URL: https://fastpay.yahooapis.jp/v1/address

サポートするHTTPメソッド: GET

サンプルリクエスト

GET /v1/address HTTP/1.1
Host: fastpay.yahooapis.jp
Authorization: Bearer 2OBRckZjTT5a3aKD……(中略)………mT1oULUNOuUlw3


レスポンス

HTTPコード

200

レスポンスパラメーター

パラメーター 返却する属性 備考
given_name#ja-Kana-JP カナ名 ユーザーが登録している名のヨミガナを返却します。
given_name#ja-Hani-JP 漢字名 ユーザーが登録している名の漢字を返却します。
family_name#ja-Kana-JP カナ姓 ユーザーが登録している姓のヨミガナを返却します。
family_name#ja-Hani-JP 漢字姓 ユーザーが登録している姓の漢字を返却します。
address 住所情報セット お客様登録済みの住所情報のセットを返却します。
address/street_address_building ビル・マンション名と部屋番号 ユーザーが登録しているビル・マンション名と部屋番号を返却します。
address/street_address_block 丁目・番地・号 ユーザーが登録している丁目・番地・号を返却します。
address/street_address 丁目・番地・号およびビル・マンション名と部屋番号 ユーザーが登録している丁目・番地・号およびビル・マンション名と部屋番号を返却します。
address/locality 市区町村 ユーザーが登録している市区町村を返却します。
address/region 都道府県 ユーザーが登録している都道府県を返却します。
address/postal_code 郵便番号 ユーザーが登録している郵便番号を返却します。
phone_number 電話番号 ユーザーが登録している電話番号を返却します。

サンプルレスポンス

HTTP/1.1 200 OK
Content-Type: application/json

{
 "given_name#ja-Kana-JP": "タロウ",
 "given_name#ja-Hani-JP": "太郎",
 "family_name#ja-Kana-JP": "ヤフウ",
 "family_name#ja-Hani-JP": "矢風",
 "address": {
    "postal_code": "1076211",
    "region": "東京都",
    "locality": "港区",
    "street_address": "赤坂9ー7ー1ミッドタウン・タワー1F",
    "street_address_block": "赤坂9ー7ー1",
    "street_address_building": "ミッドタウン・タワー1F",
 }
 "phone_number": "00012345678"
}


エラーレスポンス

access_tokenが無効の場合は以下のレスポンスを返します。

HTTP/1.1 401 Authorization Required
Content-Type: application/json

{
  "Error": {
    "Message": "Please provide valid credentials. Bearer realm=\"yahooapis.jp\", error=\"invalid_token\", error_description=\"expired token\""
  }
}

その他エラーについてはこちらをご確認ください。



よくある質問(FAQ)

属性情報が空で返却されます。

ユーザーが未登録のデータについては空文字列として返却されます。



Yahoo!知恵袋で調べる