以京东平台为例写一份电商平台API接口文档

公共参数

请求地址: 申请调用KEY地址

名称	类型	必须	描述
key	String	是	调用key（必须以GET方式拼接在URL中）
secret	String	是	调用密钥
api_name	String	是	API接口名称（包括在请求地址中）[item_search,item_get,item_search_shop等]
cache	String	否	[yes,no]默认yes，将调用缓存的数据，速度比较快
result_type	String	否	[json,jsonu,xml,serialize,var_export]返回数据格式，默认为json，jsonu输出的内容中文可以直接阅读
lang	String	否	[cn,en,ru]翻译语言，默认cn简体中文
version	String	否	API版本

请求参数

请求参数：num_iid=10335871600

参数说明：num_iid:JD商品ID
url:京东域名[非item.jd.com需传]
(npcitem.jd.hk:京东国际,item.jkcsjd.com:京东大药房)

响应参数

Version: Date:

名称	类型	必须	示例值	描述
items	items[]	0		获得JD商品详情
num_iid	Bigint	0	29186819959	商品ID
title	String	0	MOCO2018夏季新品时尚V领条纹连衣裙 摩安珂 蓝白条色 S	商品标题
desc_short	String	0		商品简介
price	Float	0	719.0	价格
total_price	Float	0	0
suggestive_price	Float	0	0
orginal_price	Float	0	1199.00	原价
nick	String	0	MO&Co.官方旗舰店	掌柜昵称
num	Int	0	999
min_num	Int	0	0
detail_url	String	0	http://item.jd.com/29186819959.html	商品链接
pic_url	String	0	//img14.360buyimg.com/n0/jfs/t22033/147/1051007175/85125/c44dd0df/5b1f2855Ncbe35858.jpg	商品图片
brand	String	0		品牌名称
brandId	Int	0		品牌ID
rootCatId	Int	0	1343	顶级分类ID
cid	Int	0	9719
crumbs	Mix	0	[]
created_time	String	0
modified_time	String	0
delist_time	String	0
desc	String	0
desc_img	Mix	0	[]
item_imgs	Mix	0	[{ "url": "//img14.360buyimg.com/n0/jfs/t22033/147/1051007175/85125/c44dd0df/5b1f2855Ncbe35858.jpg"}]	商品图片
item_weight	String	0
item_size	String	0
location	String	0		发货地
post_fee	Float	0	6.00	物流费用
express_fee	Float	0	6.00	快递费用
ems_fee	Float	0	6.00	EMS费用
shipping_to	String	0		发货至
has_discount	Boolean	0	false
video	Mix	0	[]	商品视频
is_virtual	String	0
sample_id	String	0		商品风格标识ID
is_promotion	Boolean	0
props_name	String	0	0:0:尺码:S;0:1:尺码:XS;0:2:尺码:M;0:3:尺码:L;0:4:尺码:XL	商品属性名
prop_imgs	Mix	0	{"prop_img": []}	商品属性图片列表
property_alias	String	0	0:0:S;0:1:XS;0:2:M;0:3:L;0:4:XL	商品属性别名
props	Mix	0	[{ "name": "尺码","value": "S XS M L XL" }]	商品详情
total_sold	Int	0
skus	Mix	0	{"sku": [{"price": "719.00", "orginal_price": "1199.00", "properties": "0:0", "properties_name": "0:0:尺码:S", "quantity": 99, "sku_id": 29186819959, "sku_url": "http://item.jd.com/29186819959.html"}]	商品规格信息
seller_id	Int	0		卖家ID
sales	Int	0		销量
shop_id	Int	0		店铺ID
props_list	Mix	0	{"0:0": "尺码:S"}	商品属性
seller_info	Mix	0	{"level": null, "shop_type": null, "user_num_id": 57467, "cid": null, "delivery_score": null, "item_score": null, "score_p": null, "zhuy": "//moco.jd.com", "search_id": "", "nick": "MO&Co.官方旗舰店", "shop_name": "MO&Co.官方旗舰店", "title": "MO&Co.官方旗舰店" }	卖家信息
tmall	Boolean	0	false	是否天猫
error	String	0		错误信息
warning	String	0		警告信息
url_log	Mix	0	[]
props_img	Mix	0	[]	属性图片
shop_item	Mix	0	[]
relate_items	Mix	0	[]

 

-- 请求示例 url 默认请求参数已经URL编码处理
curl -i "https://api-gw.…….cn/jd/item_get/?key=<您自己的apiKey>&secret=<您自己的apiSecret>&num_iid=10335871600"

 

 

参数说明

• 通用参数说明
  • url说明 https://api-gw.onebound.cn/平台/API类型/ 平台：淘宝，京东等， API类型:[item_search,item_get,item_search_shop等]
  • version:API版本
  • key:调用key,测试key:test_api_key
  • secret:调用secret,测试secret:(不用填写)
  • cache:[yes,no]默认yes，将调用缓存的数据，速度比较快
  • result_type:[json,xml,serialize,var_export]返回数据格式，默认为json
  • lang:[cn,en,ru] 翻译语言，默认cn简体中文
  • secret:密钥

• API:item_search 参数说明：

  • q:搜索关键字
  • cat:分类ID
  • start_price:开始价格
  • end_price:结束价格
  • sort:排序[bid,bid,bid2,_bid2,_sale,_credit]
    (bid:总价,bid2:商品价格,sale:销量,credit信用,加前缀为从大到小排序)
  • page:页数
  • page_size:每页宝贝数量，默认40
  • seller_info:是否获取商家信息[yes,no],默认yes

• API:item_get 参数说明: num_iid:宝贝ID