词条 | 比价API |
释义 | 概述商品比价API,是指通过通过专门的商品价格API数据,使得网站开发人员和站长可以获得诸如京东、亚马逊中国、易迅、苏宁易购等B2C商城中商品的价格信息,构建自己的APP、网站、Widgets或者其他数据服务。这种商品比价API是完全免费开放给开发人员和站长的。 目前互联网上提供商品比价API的只有时时价比价网,现在开放的是Verion 1版,在下一版本会添加的的国美电器、淘宝商城、新蛋、当当等网上商城的价格信息及商品信息。 快速入门商品比价API采用RESTFul风格,数据格式统一为JSON。 下面通过一个简单的示例来演示商品比价API的使用。 "api开放网址//v1/product/183.js?apikey=yourapikey" 商品比价API将返回一个JSON文档 {"id":"183","title":"苹果iphone 4手机(3G手机,16GB,黑色,支持wifi)","brand":"苹果(apple)","type":"iphone4","department":{"id":"21","departmentKey":"mobilephone","title":"手机"},...以下省略。 API Key申请防止API被恶意使用,商品比价API开放网站要求所有API请求附加API KEY,请在注册并登陆后,访问开发者页面。 API 参考手册通用说明API总是形如: "api开放网址/<version>/products.<format>/?page=<page>&rows=<rows>&apikey=<apikey>" 以下说明在每个 API请求中都需要包含的参数 参数 是否必须 意义 说明 version 是 API版本,目前版本只有v1 apikey 是 APIKey 为防止API被恶意使用,时时价要求API请求附加API KEY, APIKey的申请请参考本页相关章节 format 否 返回值格式,默认为js 目前只支持json格式 page 否 返回多个元素时,页数 页数只支持数字,如果留空则返回第一页 rows 否 返回多个元素时,每页显示的数量 最大值为30 返回状态说明商品比价API通过HTTP Status Code来说明API请求是否成功,Status Code与W3C HTTP1.1规范保持一致。下面列举了可能的返回状态及其意义: 状态码 意义 200 OK 请求成功 201 CREATED 创建成功 202 ACCEPTED 更新成功 204 NO CONTENT 请求成功但是没有找到对应的数据 400 BAD REQUEST 请求中包含错误的参数 401 UNAUTHORIZED 未授权 403 FORBIDDEN 被禁止访问 404 NOT FOUND 请求的资源不存在 500 INTERNAL SERVER ERROR 内部错误 支持的B2C商城商品比价API V1目前支持如下商城: 商城名称 storeKey URL 京东商城 jingdong 请查看参考资料 卓越亚马逊 amazon 请查看参考资料 易迅 icson 请查看参考资料 storeKey会用于API的URL搜索查询 目录获得目录列表 "GET api开放网址/v1/departments" 返回结果是一个数据集合,以数组形式出现,包括所有的产品目录: [{"id":"11","departmentKey":"mobile","title":"手机通讯","parentId":null},{"id":"29","departmentKey":"e-book","title":"电子书","parentId":"12"},] 返回值说明: 名称 意义 备注 id 目录的ID departmentKey 目录的Key值 title 目录的名称 parentId 目录的上级目录ID 如有没有上级目录则为null 获得单个目录信息 "GET api开放网址/v1/department/<departmentKey> " 返回结果是一个对象出现,包括产品目录信息: {"id":"45","departmentKey":"tablets","title":"平板电脑","parentId":"14"} 返回值说明 名称 意义 备注 id 目录的ID departmentKey 目录的Key值 title 目录的名称 parentId 目录的上级目录ID 如有没有上级目录则为null 产品搜索 "GET api开放网址/v1/search/{keyword}/{storeKey}/{departmentKey}/{order}" 返回结果是一个数据集合,分为两部分,pager部分为搜索的总数及分页信息, products部分为符合搜索条件的产品信息集合。 允许的排序 order 意义 relevance 按相关性从高到低 popular 按热门程度从高到低(时时价降价通知的订阅情况) discount 按折扣从高到低 pricedesc 按价格从高到低 priceasc 按价格从低到高 获得产品信息 "GET api开放网址/v1/product/<productId>" 返回结果是一个数据对象,包含了产品的所有信息。 返回值说明 名称 意义 备注 id 产品的ID title 产品名称 url 产品URL brand 品牌 type 型号 department 所属目录 buylink 最低价商城的购买链接 stock 产品有货/无货的标记 只有当所有的比价商城都无货时这里才会标记为无货 cover 商品图片 lowPrice 商品当前最低价 highPrice 商品当前最高价 averagePrice 商品历史平均价格 lowestPrice 商品历史最低价格 lowestPriceDate 商品历史最低价格发生时间 highestPrice 商品历史最高价格 highestPriceDate 商品历史最高价格发生时间 marketPrice 商品市场价 logDays 价格已追踪天数 lowPriceStore 最低价商城信息 stores 所有商城信息 images 商品图片集合 当一个商品有复数张图片时,这里会以数组形式出现 lastLogTime 价格最后更新时间 优惠信息 产品可能会存在优惠信息,产品的优惠信息简单归纳为下列项目 中文名称 Key 备注 换购 redemption 赠品 gifts 返券 coupons 限时折扣 flashsale 以旧换新 newforold 售后服务售后服务概要信息 中文名称 Key 备注 免运费 freedelivery 无条件退货 refund 增值税发票 vatinvoice 分期付款 installment 延长质保 extendwarranties 价格保护 protectiveprice 价格获得单个产品在某个时间段内的价格 "GET api开放网址/v1/price/<productId>?start={startTime}&end={endTime} " 请求参数说明 参数 是否必须 意义 说明 productId 是 产品ID startTime 否 查询开始时间 如果没有指定,则默认为与终止时间间隔31天的时间点 endTime 否 查询终止时间 如果没有指定,则默认为当前时刻 返回结果是一个数组对象,包含了产品在指定时间段内的价格记录。 |
随便看 |
百科全书收录4421916条中文百科知识,基本涵盖了大多数领域的百科知识,是一部内容开放、自由的电子版百科全书。