api-list.md
15.3 KB
线上域名 ：https://api-global.yohobuy.com
1.editor
1).品牌列表
地址 ： /editor/api/v1/brand/brandList
例 ：http://api-global.yohobuy.com/editor/api/v1/brand/brandList?app_version=5.2.0.1611240002&client_secret=9c3782ce9830ef348ac062c5b605dde6&client_type=iphone&fromPage=iFP_GlobalBrand&os_version=9.2&screen_size=320x568&v=7&yh_channel=1
必填参数
client_type 客户端类型
client_secret 加密字符串
2).品牌详情
地址 ：/editor/api/v1/brand/get
例 : http://api-global.yohobuy.com/editor/api/v1/brand/get?brandId=2&client_type=iphone&client_secret=13566d772b057e01a2ae5b1550bbbcf1
必填参数
brandId 品牌id
client_type 客户端类型
client_secret 加密字符串
3).运营品类列表
地址 ：/editor/api/v1/osort/osortList
例 ：http://api-global.yohobuy.com/editor/api/v1/osort/osortList?brandId=2&client_type=iphone&client_secret=13566d772b057e01a2ae5b1550bbbcf1
必填参数
client_type 客户端类型
client_secret 加密字符串2.express模块
1).转运四方---集货模式
地址 ：/express/api/v1/fourpxstore/api
例 : http://api-global.yohobuy.com/express/api/v1/fourpxstore/api
必填参数: { SeqID: , Type:, Timestamp:, Data:{ShipperOrderNo:,CarrierDeliveryNo:,CarrierCompanyCode:}, Signature: }
2).海米派
地址 ：/express/api/v1/haimibuy/transport
例 : http://api-global.yohobuy.com/express/api/v1/haimibuy/transport
必填参数:{timestamp:,token:,data:{express_no:,express_status:,cn_transfer_company:,cn_transfer_no:,
express_infos:[{time:,context:}] } }
3).一号仓
地址 ：/express/api/v1/onehcang/transport
例 : http://api-global.yohobuy.com/express/api/v1/onehcang/transport
必填参数:{timestamp:,token:,data:{express_no:,express_status:,cn_transfer_company:,cn_transfer_no:,
express_infos:[{time:,context:}] } }3.image模块
1).获取七牛私有空间上传token
地址 ：/image/api/v1/upload/gettoken
例 ：http://api-global.yohobuy.com/image/api/v1/upload/gettoken?bucket=skn&client_type=iphone&client_secret=13566d772b057e01a2ae5b1550bbbcf1
必填参数
bucket 空间名
client_type 客户端类型
client_secret 加密字符串
2).上传到七牛普通空间
地址 ：/image/api/v1/upload/upload
例 ：http://api-global.yohobuy.com/image/api/v1/upload/upload?bucket=skn&image=&&&&&&
必填参数
bucket 空间名
image form表单文件流
3).上传到七牛私有空间
地址 ：/image/api/v1/upload/uploadPrivate
例 ：http://api-global.yohobuy.com/image/api/v1/upload/uploadprivate?bucket=skn&image=&&&&&&
必填参数
bucket 空间名
image form表单文件流4.order模块
4.1.地址管理
1).收货地址信息列表
地址 ：/order/api/v1/address/infoList
例 ：http://api-global.yohobuy.com/order/api/v1/address/infoList?uid=5000000&client_type=iphone&client_secret=bff599fa9c8f42e440a26a8e3cfdc399
必填参数
uid 用户ID
client_type 客户端类型
client_secret 加密字符串
2).新增收货地址信息
地址 ：/order/api/v1/address/add
例 ：http://api-global.yohobuy.com/order/api/v1/address/add?
必填参数
uid 用户ID
address 地址
area_code 编码
mobile 手机号
consignee 收货人姓名
card_number 身份证号码
card_positive 身份证正面照 [url]
card_negative 身份证反面照 [url]
client_type 客户端类型
client_secret 加密字符串
3).修改收货地址信息
地址 ：/order/api/v1/address/edit
例 ：http://api-global.yohobuy.com/order/api/v1/address/edit?
必填参数
uid 用户ID
id
address 地址
area_code 编码
mobile 手机号
consignee 收货人姓名
card_number 身份证号码
card_positive 身份证正面照 [url]
card_negative 身份证反面照 [url]
client_type 客户端类型
client_secret 加密字符串
4).删除收货地址信息
地址 ：/order/api/v1/address/delete
例 ：http://api-global.yohobuy.com/order/api/v1/address/delete?
必填参数
uid 用户ID
id
client_type 客户端类型
client_secret 加密字符串
5).设置默认地址信息
地址 ：/order/api/v1/address/setDefault
例 ：http://api-global.yohobuy.com/order/api/v1/address/setDefault?
必填参数
uid 用户ID
id
client_type 客户端类型
client_secret 加密字符串4.2.购物车
1).购物车数量接口
地址 ：/order/api/v1/cart/getCartGoodCount
例 : https://api-global.yohobuy.com/order/api/v1/cart/getCartGoodCount?v=7&app_version=4.9.0&client_type=android&yh_channel=1&screen_size=540x960&client_secret=606cdeff302bd5279a40222b7ddac701&uid=9248477&gender=1%2C3&os_version=android5.0.2%3ASM-A3000&session_key=951eb3f782e471cd649e411a26518ffc&shopping_key=
必填参数
uid 用户id
client_type 客户端类型
client_secret 加密字符串
shopping_key 临时购物车key
2).购物车列表接口
地址 ：/order/api/v1/cart/getCartGoodList
例 : https://api-global.yohobuy.com/order/api/v1/cart/getCartGoodList?v=7&app_version=4.9.0&client_type=android&yh_channel=1&screen_size=540x960&client_secret=606cdeff302bd5279a40222b7ddac701&uid=9248477&gender=1%2C3&os_version=android5.0.2%3ASM-A3000&session_key=951eb3f782e471cd649e411a26518ffc&shopping_key=
必填参数
uid 用户id
client_type 客户端类型
client_secret 加密字符串
shopping_key 临时购物车key
3).添加购物车商品
地址 ：/order/api/v1/cart/addToCart
必填参数
uid 用户id
shopping_key 临时购物车key
client_type 客户端类型
client_secret 加密字符串
add_goods_list json字符串
array(
product_skn
product_skc
product_sku
buy_number
selected
)
4).编辑购物车中商品
地址 ：/order/api/v1/cart/updateGoodInCart
必填参数
uid 用户id
shopping_key 临时购物车key
client_type 客户端类型
client_secret 加密字符串
update_goods_list json字符串
array(
array(
before_update => array(
product_skn
product_skc
product_sku
)
after_update => array(
product_skn
product_skc
product_sku
buy_number
selected
)
)
)
5).删除购物车商品
地址 ：/order/api/v1/cart/delFromCart
必填参数
uid 用户id
shopping_key 临时购物车key
client_type 客户端类型
client_secret 加密字符串
del_goods_list json字符串
array(
product_skn
product_skc
product_sku
)
6).增加购物车中商品数量
地址：/order/api/v1/cart/increaseBuyNumber
必填参数
uid 用户id
shopping_key 临时购物车key
client_type 客户端类型
client_secret 加密字符串
product_skn
product_skc
product_sku
buy_number
7).减少购物车中商品数量
地址：/order/api/v1/cart/decreaseBuyNumber
必填参数
uid 用户id
shopping_key 临时购物车key
client_type 客户端类型
client_secret 加密字符串
product_skn
product_skc
product_sku
buy_number
8).选中商品后,更新商品信息
地址 ：/order/api/v1/cart/updateGoodSelect
必填参数
uid 用户id
shopping_key 临时购物车key
client_type 客户端类型
client_secret 加密字符串
update_goods_list json字符串
array(
product_skn
product_skc
product_sku
selected
)
9).移入收藏夹
地址:/order/api/v1/cart/moveToCollect
必填参数
uid 用户id
client_type 客户端类型
client_secret 加密字符串
move_goods_list json字符串
array(
product_skn
product_skc
product_sku
)4.3.收藏
1).收藏列表
地址 ：/order/api/v1/collect/getCollectList
例 ：http://api-global.yohobuy.com/order/api/v1/collect/getCollectList?type=product&uid=5000000&client_type=iphone&client_secret=28472060b7a76453c41cff913038230d&limit=50&page=1
必填参数
uid 用户id
type 收藏类型
limit 限制显示数量
page 当前页数
client_type 客户端类型
client_secret 加密字符串
2).添加收藏商品
地址：/order/api/v1/collect/addToCollect
必填参数
uid 用户id
type 收藏类型 product
fav_id 商品skn
client_type 客户端类型
client_secret 加密字符串
3).取消收藏商品
地址：/order/api/v1/collect/cancelFromCollect
必填参数
uid 用户id
type 收藏类型 product
fav_id 商品skn
client_type 客户端类型
client_secret 加密字符串4.4.下单确认
1).预览下单信息
地址：/order/api/v1/confirm/preview
必填参数
uid 用户id
address_id 地址ID
client_type 客户端类型
client_secret 加密字符串
2).确认下单
地址：/order/api/v1/confirm/confirm
必填参数
uid 用户id
address_id 地址ID
remark 备注
client_type 客户端类型
client_secret 加密字符串4.5.订单详情
1).根据订单id获取订单详情
地址：/order/api/v1/detail/get
例 ：http://api-global.yohobuy.com/order/api/v1/detail/get?order_id=15120310489&client_type=iphone&client_secret=5893afad34e3e0d0256b7b2c3c115d99
必填参数
order_id 订单id
client_type 客户端类型
client_secret 加密字符串
2).获取订单列表
地址 ：/order/api/v1/detail/getList
例 ：http://api-global.yohobuy.com/order/api/v1/detail/getList?uid=5000000&page=1&limit=10&type=0&client_type=iphone&client_secret=e95ddb1b2627d4c1e172c36a0f9207cc
必填参数
uid 用户id
limit 限制显示数量
page 当前页数
type 订单类型
client_type 客户端类型
client_secret 加密字符串
3).个人中心调用 订单数量+收藏商品数量接口
地址 ：/order/api/v1/detail/getCount
例 ：https://api-global.yohobuy.com/order/api/v1/detail/getCount?v=7&app_version=4.9.0&client_type=android&yh_channel=1&screen_size=540x960&client_secret=606cdeff302bd5279a40222b7ddac701&uid=9248477&gender=1%2C3&os_version=android5.0.2%3ASM-A3000&session_key=951eb3f782e471cd649e411a26518ffc&shopping_key=
必填参数
uid 用户id
type 类型
client_type 客户端类型
client_secret 加密字符串
4).更新身份证信息
地址 ：/order/api/v1/detail/postIDCard
必填参数:
order_id
idcard_front 身份证正面
idcard_back 身份证反面
client_type 客户端类型
client_secret 加密字符串
5).取消订单
地址 ：/order/api/v1/detail/cancel
参数
cancel_order_reason_id
order_id
uid
client_type 客户端类型
client_secret 加密字符串
6).删除订单
地址 ：/order/api/v1/detail/del
参数
order_id
uid
7).获取订单物流详情
地址 ：/order/api/v1/detail/getExpress
例 ：http://api-global.yohobuy.com/order/api/v1/detail/getExpress?order_id=15120310489&client_type=iphone&client_secret=5893afad34e3e0d0256b7b2c3c115d99
必填参数
order_id 订单id
client_type 客户端类型
client_secret 加密字符串
8).修改订单价格
地址 ：/order/api/v1/detail/changePrice
必填参数
order_id 订单id
price
client_type 客户端类型
client_secret 加密字符串
9).修改订单状态
地址 ：/order/api/v1/detail/setStatus
必填参数
order_id 订单id
status
client_type 客户端类型
client_secret 加密字符串
10).订单取消原因列表
地址 ：/order/api/v1/detail/getReasonForCancelOrder
必填参数
client_type 客户端类型
client_secret 加密字符串
11).修改订单地址
地址 ：/order/api/v1/detail/editAddress
必填参数
uid
address_id
order_id
client_type 客户端类型
client_secret 加密字符串
12).确认收货
地址 ：/order/api/v1/detail/tradeSuccess
必填参数
order_id
client_type 客户端类型
client_secret 加密字符串
13).再次购买
地址 ：/order/api/v1/detail/cartAdd
必填参数
uid
order_id
client_type 客户端类型
client_secret 加密字符串4.6.支付
1).支付宝付款签名
地址 ：/order/api/v1/pay/alipayGetSign
必填参数:
data:json字符
client_type 客户端类型
client_secret 加密字符串
2).支付宝支付成功回调
地址 ：/order/api/v1/pay/alipayPaySuccess
必填参数:
out_trade_no
total_fee
sign
sign_type
3).支付宝退款成功回调
地址 ：/order/api/v1/pay/alipayRefundSuccess
必填参数:5.product模块
1).根据商品SKN获取商品详情
地址 ：/product/api/v1/detail/get
例 ：http://api-global.yohobuy.com/product/api/v1/detail/get?app_version=3.8.1.1511270001&client_secret=d25bb3b4c5fc6a5337588e33bd09571f&client_type=iphone&os_version=9.1&product_skn=5000426&screen_size=320x568&v=7
必填参数
product_skn 商品skn
client_type 客户端类型
client_secret 加密字符串
2).根据商品SKN获取商品详情H5页面
地址 ： /product/api/v1/detail/gethtml
例 ：http://api-global.yohobuy.com/product/api/v1/detail/gethtml?app_version=3.8.1.1511270001&client_secret=d25bb3b4c5fc6a5337588e33bd09571f&client_type=iphone&os_version=9.1&product_skn=5000426&screen_size=320x568&v=7
必填参数
product_skn 商品skn
client_type 客户端类型
client_secret 加密字符串
3).获取商品列表
地址1 ：/product/api/v1/detail/getList
地址 ：/product/api/v2/detail/getList
例 ：https://api-global.yohobuy.com/product/api/v2/detail/getList?app_version=4.8.0.1607260003&brand=37&client_secret=5abd1a5f42b4bff2abfadc700a055e0d&client_type=iphone&limit=60&order=s_t_desc&os_version=9.3&page=1&screen_size=375x667&v=7
必填参数
client_type 客户端类型
client_secret 加密字符串
其他参数 （所有列表页面通过传参不同 显示不同结果）
page 页数
limit 限制显示数量
order 排序规则
site 网站id
brand 品牌id
sort 第四层物理类目id
color 颜色
gender 性别
yh_channel 频道
is_limited 是否限量
price 价格区间
msort
site_id 网站id
4).获取商品总数（供搜索引擎）
地址 ：/product/api/v1/detail/getProductsCountForSearch
必填参数
client_type 客户端类型
client_secret 加密字符串
brand_id
5).分页获取商品数据（供搜索引擎）
地址 ：/product/api/v1/detail/getProductsListForSearch
必填参数
client_type 客户端类型
client_secret 加密字符串
brand_id
offset
limit
6).获取商品详情页推荐商品
地址 ：/product/api/v1/detail/getRecommends
例 ：http://api-global.yohobuy.com/product/api/v1/detail/getRecommends?app_version=3.8.1.1511270001&client_secret=d25bb3b4c5fc6a5337588e33bd09571f&client_type=iphone&os_version=9.1&product_skn=5000426&screen_size=320x568&v=7
必填参数
product_skn 商品skn
client_type 客户端类型
client_secret 加密字符串