闲鱼开放平台

闲鱼开放平台

专用API
【更新时间: 2024.08.15】 闲鱼开放平台是阿里巴巴集团旗下闲鱼项目的开放接口平台,专为开发者提供技术支持和服务。通过开放的闲鱼API,帮助开发者快速集成闲鱼的多种功能。无论是商品发布、订单管理还是用户互动,闲鱼API都能为开发者提供便捷的解决方案。
服务星级:2星
⭐ ⭐ 🌟 🌟 🌟 🌟 🌟
调用次数
0
集成人数
0
商用人数
0
! SLA: N/A
! 响应: N/A
! 适用于个人&企业
收藏
×
完成
取消
×
书签名称
确定
<
产品介绍
>

什么是闲鱼开放平台?

该服务是为闲鱼小程序合作方提供的服务端接入文档,详细说明了如何在聚石塔环境中部署服务端服务,如何进行用户登录授权,以及如何使用闲鱼提供的API进行订单管理和用户信息查询等操作。文档提供了详细的API列表、消息汇总、API调用身份说明、TOPAPI环境地址确认、权限申请流程以及部分API的详细说明,旨在帮助合作方快速接入闲鱼平台,实现业务的自动化和智能化管理。

什么是闲鱼开放平台?

由服务使用方的应用程序发起,以Restful风格为主、通过公网HTTP协议调用闲鱼开放平台,从而实现程序的自动化交互,提高服务效率。

闲鱼开放平台有哪些核心功能?

  1. 订单创建:服务商可以通过TOP接口调用创单API创建闲鱼订单
  2. 发货接口-虚拟发货:该接口适用于无需物流发货的场景。对应创单时不需要传入deliver_id的情况。
  3. 发货接口-有物流发货:有实物物流的发货场景,对应创单时需要传入deliver_id的情况
  4. 物流公司编码查询:通过该接口可以查询支持的物流公司编码。
  5. 逆向订单查询:该接口用于查询用户退货、换货等逆向订单信息。
  6. 正向订单查询:该接口用于查询用户购买的正向订单信息。
  7. 退款单处理:通过该接口可以处理用户的退款申请。
  8. 服务商主动取消订单(未发货):服务商在订单未发货的情况下,可以通过该接口主动取消订单。
  9. 正向订单变更消息:该接口用于查询或监听正向订单的变更消息。
  10. 逆向订单变更消息:该接口用于查询或监听逆向订单的变更消息。
  11. 用户基础信息(性别、头像、昵称):该接口用于获取用户的基础信息,包括性别、头像和昵称。

闲鱼开放平台的核心优势是什么?

 

  1. 丰富的功能接口:闲鱼开放平台提供了多种接口,覆盖商品管理、订单处理、用户管理等各个方面,满足开发者的多样化需求。
  2. 高效的开发支持:平台提供详细的开发文档和技术支持,帮助开发者快速上手并高效完成开发任务。
  3. 稳定的系统性能:作为阿里巴巴旗下产品,闲鱼开放平台拥有强大的技术底蕴和稳定的系统性能,确保开发者在使用过程中能够获得良好的体验。

 

在哪些场景会用到闲鱼开放平台?

电商平台的二手商品专区:一个大型电商平台想要增加一个二手商品交易专区,可以通过闲鱼开放平台的接口,将商品发布、订单管理等功能接入到自己的平台中,从而为用户提供一个可靠的二手商品交易服务。

 

 

社交媒体的二手交易功能:一个社交媒体平台希望增加用户互动的多样性,决定增加二手交易功能。通过闲鱼开放平台的用户管理和商品发布接口,可以让用户在社交平台上直接发布和管理自己的二手商品,增强平台的用户粘性。

 

二手商品市场分析:在电商平台上,二手商品市场的需求不断增长。利用“闲鱼开放平台”API接口,商家可以实时获取闲鱼上的商品信息,如价格、销量和用户评论。这些数据可以帮助商家分析市场趋势、制定定价策略以及优化库存管理。

 

<
使用指南
>

服务API使用指南

1. 环境准备

1.1 聚石塔接入

  • 所有服务端服务必须部署在聚石塔内。

  • 用户ID、订单信息需存储在聚石塔数据库中。

  • 访问聚石塔外部资源需要审批。

1.2 相关文档

2. 用户登录授权

2.1 授权流程

  1. 前端获取授权码(code)。

  2. 服务器使用code和AppSecret调用taobao.top.auth.token.create接口换取accessToken。

  3. accessToken用于后续请求TOP接口。

2.2 注意事项

  • 授权码仅能使用一次,需重新获取。

  • accessToken在过期之前无需重新获取。

  • 可使用setStoragegetStorage API缓存用户信息,避免频繁获取code。

3. API调用

3.1 API汇总

  • 订单创建: alibaba.idle.isv.goosefish.order.create

  • 订单查询(正向): alibaba.idle.isv.order.query

  • 虚拟发货: alibaba.idle.isv.goosefish.virtual.delivery

  • 物流发货: alibaba.idle.isv.order.ship

  • 订单查询(逆向): alibaba.idle.isv.refund.query

  • 发货前关闭订单: alibaba.idle.isv.order.close

  • 部分退款: alibaba.idle.isv.order.part.refund

  • 发货后退款关单: alibaba.idle.isv.order.after.send.refund

  • 退货退款处理: alibaba.idle.isv.order.dealrefund

  • 物流公司编码查询: alibaba.idle.logistics.companies.query

  • 用户基础信息: alibaba.idle.goosefish.user.info.query

3.2 消息汇总

  • 正向交易消息: idle_autotrade_OrderStateSync

  • 逆向交易消息: idle_autotrade_RefundSync

4. API调用身份说明

  • 订单创建和用户基础信息接口需使用当前登录用户的accessToken。

  • 其他涉及卖家的接口需使用卖家的accessToken。

5. TOPAPI 环境地址

  • 正式地址: https://gw.api.taobao.com/router/rest

  • 预发地址: https://pre-gw.api.taobao.com/top/router/rest(仅在闲鱼侧更新或新增时使用)

5.1 预发联调

  • 在联调前联系闲鱼开发同学开通预发环境联调权限。

6. 权限申请

  • 在闲鱼三方开发平台发起API权限申请,确保只申请必要的API。

7. 部分API详细说明

7.1 订单创建

  • 调用alibaba.idle.isv.goosefish.order.create创建闲鱼订单。

7.2 订单查询

  • 使用alibaba.idle.isv.order.query查询订单状态。

7.3 发货接口

  • 虚拟发货: 使用alibaba.idle.isv.goosefish.virtual.delivery接口。

  • 有物流发货: 使用alibaba.idle.isv.order.ship接口。

7.4 逆向订单查询

  • 使用alibaba.idle.isv.refund.query查询退款状态。

7.5 退款处理

  • 使用alibaba.idle.isv.order.dealrefund处理退款。

8. 消息处理

  • 监听idle_autotrade_OrderStateSyncidle_autotrade_RefundSync消息以获取订单状态变化。

通过以上步骤,用户可以顺利对接和集成服务API。

 

详情查看链接:https://open.goofish.com/doc/development/dev/server.html

<
产品问答
>
?
初次接入小程序,需要申请哪些权限?
权限分为客户端接口权限和服务端接口权限,需要在管理平台上申请权限后才能使用。具体可以参考【小程序快速接入】申请API权限
?
小程序对浏览器API支持是否完整;在SPA应用下,是否支持History模式?
都支持的。闲鱼小程序可以理解为一个能力增强,但是被平台管控受限的H5。都支持的。闲鱼小程序可以理解为一个能力增强,但是被平台管控受限的H5。
?
入驻闲鱼小程序,必须要部署“聚石塔服务”吗?
是的。闲鱼小程序调用的后端接口,都必须部署到聚石塔上。
?
聚石塔如何接入?
参考文档:https://open.taobao.com/docV3.htm?docId=982&docType=1&source=search#s2参考文档:https://open.taobao.com/docV3.htm?docId=982&docType=1&source=search#s2
?
部署到聚石塔的接口可以调用外部接口吗?
可以。聚石塔内外互通是通过奇门接口实现的。具体可以参考:聚石塔内外互通说明。
?
小程序内使用的闲鱼账号和淘宝开发者账号,可以用个人账号吗?如果是用个人账号,后期还能再变更为公司账户...
为保障整体业务流畅,请使用与闲鱼签约的企业账号申请闲鱼账号和淘宝开发者账号;如果使用个人账号,后期不支持变更,所以推荐使用企业账号。理论上淘宝开放平台入驻主体 、闲鱼入驻主体、合同签约主体,三者应该一致。为保障整体业务流畅,请使用与闲鱼签约的企业账号申请闲鱼账号和淘宝开发者账号;如果使用个人账号,后期不支持变更,所以推荐使用企业账号。理论上淘宝开放平台入驻主体 、闲鱼入驻主体、合同签约主体,三者应该一致。
<
关于我们
>
闲鱼是中国领先的二手交易平台,隶属于阿里巴巴集团,致力于为用户提供安全、便捷的二手商品交易服务。用户可以通过闲鱼发布、购买和交换二手商品,同时享受专业的售后保障和社区互动功能。闲鱼开放平台提供丰富的API接口,支持小程序开发者快速接入和发布集成,为广大开发者提供了便利的技术支持和文档指导。
联系信息
服务时间: 00:00:00至24:00:00
网页在线客服: 咨询
API接口列表
<
使用指南
>

服务API使用指南

1. 环境准备

1.1 聚石塔接入

  • 所有服务端服务必须部署在聚石塔内。

  • 用户ID、订单信息需存储在聚石塔数据库中。

  • 访问聚石塔外部资源需要审批。

1.2 相关文档

2. 用户登录授权

2.1 授权流程

  1. 前端获取授权码(code)。

  2. 服务器使用code和AppSecret调用taobao.top.auth.token.create接口换取accessToken。

  3. accessToken用于后续请求TOP接口。

2.2 注意事项

  • 授权码仅能使用一次,需重新获取。

  • accessToken在过期之前无需重新获取。

  • 可使用setStoragegetStorage API缓存用户信息,避免频繁获取code。

3. API调用

3.1 API汇总

  • 订单创建: alibaba.idle.isv.goosefish.order.create

  • 订单查询(正向): alibaba.idle.isv.order.query

  • 虚拟发货: alibaba.idle.isv.goosefish.virtual.delivery

  • 物流发货: alibaba.idle.isv.order.ship

  • 订单查询(逆向): alibaba.idle.isv.refund.query

  • 发货前关闭订单: alibaba.idle.isv.order.close

  • 部分退款: alibaba.idle.isv.order.part.refund

  • 发货后退款关单: alibaba.idle.isv.order.after.send.refund

  • 退货退款处理: alibaba.idle.isv.order.dealrefund

  • 物流公司编码查询: alibaba.idle.logistics.companies.query

  • 用户基础信息: alibaba.idle.goosefish.user.info.query

3.2 消息汇总

  • 正向交易消息: idle_autotrade_OrderStateSync

  • 逆向交易消息: idle_autotrade_RefundSync

4. API调用身份说明

  • 订单创建和用户基础信息接口需使用当前登录用户的accessToken。

  • 其他涉及卖家的接口需使用卖家的accessToken。

5. TOPAPI 环境地址

  • 正式地址: https://gw.api.taobao.com/router/rest

  • 预发地址: https://pre-gw.api.taobao.com/top/router/rest(仅在闲鱼侧更新或新增时使用)

5.1 预发联调

  • 在联调前联系闲鱼开发同学开通预发环境联调权限。

6. 权限申请

  • 在闲鱼三方开发平台发起API权限申请,确保只申请必要的API。

7. 部分API详细说明

7.1 订单创建

  • 调用alibaba.idle.isv.goosefish.order.create创建闲鱼订单。

7.2 订单查询

  • 使用alibaba.idle.isv.order.query查询订单状态。

7.3 发货接口

  • 虚拟发货: 使用alibaba.idle.isv.goosefish.virtual.delivery接口。

  • 有物流发货: 使用alibaba.idle.isv.order.ship接口。

7.4 逆向订单查询

  • 使用alibaba.idle.isv.refund.query查询退款状态。

7.5 退款处理

  • 使用alibaba.idle.isv.order.dealrefund处理退款。

8. 消息处理

  • 监听idle_autotrade_OrderStateSyncidle_autotrade_RefundSync消息以获取订单状态变化。

通过以上步骤,用户可以顺利对接和集成服务API。

 

详情查看链接:https://open.goofish.com/doc/development/dev/server.html

<
依赖服务
>
<
产品问答
>
?
初次接入小程序,需要申请哪些权限?
权限分为客户端接口权限和服务端接口权限,需要在管理平台上申请权限后才能使用。具体可以参考【小程序快速接入】申请API权限
?
小程序对浏览器API支持是否完整;在SPA应用下,是否支持History模式?
都支持的。闲鱼小程序可以理解为一个能力增强,但是被平台管控受限的H5。都支持的。闲鱼小程序可以理解为一个能力增强,但是被平台管控受限的H5。
?
入驻闲鱼小程序,必须要部署“聚石塔服务”吗?
是的。闲鱼小程序调用的后端接口,都必须部署到聚石塔上。
?
聚石塔如何接入?
参考文档:https://open.taobao.com/docV3.htm?docId=982&docType=1&source=search#s2参考文档:https://open.taobao.com/docV3.htm?docId=982&docType=1&source=search#s2
?
部署到聚石塔的接口可以调用外部接口吗?
可以。聚石塔内外互通是通过奇门接口实现的。具体可以参考:聚石塔内外互通说明。
?
小程序内使用的闲鱼账号和淘宝开发者账号,可以用个人账号吗?如果是用个人账号,后期还能再变更为公司账户...
为保障整体业务流畅,请使用与闲鱼签约的企业账号申请闲鱼账号和淘宝开发者账号;如果使用个人账号,后期不支持变更,所以推荐使用企业账号。理论上淘宝开放平台入驻主体 、闲鱼入驻主体、合同签约主体,三者应该一致。为保障整体业务流畅,请使用与闲鱼签约的企业账号申请闲鱼账号和淘宝开发者账号;如果使用个人账号,后期不支持变更,所以推荐使用企业账号。理论上淘宝开放平台入驻主体 、闲鱼入驻主体、合同签约主体,三者应该一致。
<
关于我们
>
闲鱼是中国领先的二手交易平台,隶属于阿里巴巴集团,致力于为用户提供安全、便捷的二手商品交易服务。用户可以通过闲鱼发布、购买和交换二手商品,同时享受专业的售后保障和社区互动功能。闲鱼开放平台提供丰富的API接口,支持小程序开发者快速接入和发布集成,为广大开发者提供了便利的技术支持和文档指导。
联系信息
服务时间: 00:00:00至24:00:00
网页在线客服: 咨询