当前位置: 首页 > news >正文

产品经理对于电商接口的梳理||电商接口文档梳理与接入

接口梳理7个注意点总结

①注意要测试环境和生产环境。生产上线时候要提醒研发换到生产环境调用。

②注意必输字段和选输字段,要传入字段的含义和校验。枚举值不清楚含义的要询问对方含义,比如说单据类型字段枚举值是B2C发货单,BBC发货单,采购退货发货单等..

③注意唯一ID之间的关联,比如说我们订单系统的发货单号是001,到wms系统是否生成了一个新单号A001,那发货回执时候wms要给ODS系统001单号。

1688 API 接入说明

  1. API地址:

  2. 调用示例:

  3. 参数说明

    • 通用参数说明

      • version:API版本
      • key:调用key,测试key:test_api_key
      • api_name:API类型[item_get,item_search]
      • cache:[yes,no]默认yes,将调用缓存的数据,速度比较快
      • result_type:[json,xml,serialize,var_export]返回数据格式,默认为json
      • lang:[cn,en,ru] 翻译语言,默认cn简体中文
    • API:item_get 参数说明: num_iid:宝贝ID

  4. 此API目前支持以下基本接口:

    • item_get 获得1688商品详情
    • item_search 按关键字搜索商品
    • item_search_img 按图搜索1688商品(拍立淘)
    • item_search_suggest 获得搜索词推荐
    • item_fee 获得商品快递费用
    • seller_info 获得店铺详情
    • item_search_shop 获得店铺的所有商品
    • item_password 获得淘口令真实url
    • upload_img 上传图片到1688
    • item_search_seller 搜索店铺列表
    • img2text 图片识别商品接口
    • item_get_app 获取1688app上原数据
    • buyer_order_list 获取购买到的商品订单列表
    • cat_get 获得1688商品分类

 

④注意基础信息的映射。比如说仓库代码和对方仓库代码是否一样,商品编码和对方商品编码是否一样。如果不一样还要进行映射,那映射的工作是谁来做。

⑤注意行信息和明细(我们常说的list)数据。哪些在行中,哪些在明细中,看的是单据和字段的关系,是一对一还是一对多,一对一就在行中,一对多就在明细中。比如说发货单只有一个发货仓,那么就是在行中,但是一个发货单有多个商品,那就在明细中。

行中部分数据和明细中的数据对的上,比如说发货单总金额=∑商品行总金额(商品单价*数量),发货单总实付金额=∑商品行实付金额(实付价*数量)。实付金额≠总金额,因为还存在促销活动使用优惠券等。那下游为什么要有这个字段呢?如果这个字段值我给的不精确会有什么影响呢?这都是要和下游沟通的,比如说下游发货保价,他是根据哪个价格保的,这样你就能判断哪些字段传的精确不精确的影响。

⑥接口文档字段的校验,比如说发货单下发Wms,wms会校验商品是否存在,仓库是否存在等,这些校验服务于业务需要,比如说商品都不存在,我怎么发货呢对吧,所以双方系统的基础数据要对齐。

⑦同步方式:增量和全量。这个一般在做基础数据同步的时候,比如说商品档案,会员信息等。增量指的是增加的变动的推送给其他系统,全量是定时比如每天推一下全部的数据。

接口文档常用名词整理

同步和异步。同步指的是同一时间处理,异步指的是不能实时处理,处理完结果再告知结果,会新增接口对接。

拉取和推送。一般接口遵从谁是数据上游方,推送给下游。但是如果1个上游方对应N个下游方,这个时候上游机会提供拉取接口,下游都来拉数据。这样因为减少上游方开发工作量。上报联调。跨系统对接时把接口调通。

Mock。有时候上下游没时间和开发联调,这个时候开发可以造数据自己先调。一般开发用postman工具mock接口。

调用地址/URL。生产环境测试环境

API接口和MQ。MQ【消息队列/消息中间件】可以用于内部系统对接非实时部分,具体看研发设计。

相关文章:

  • 【Axure教程】表格嵌套卡片
  • Axure复选框组件的深度定制:实现自定义大小、颜色与全选功能
  • NestJS 统一异常处理 + 日志追踪链路设计
  • MySQL数据库基本操作-DQL-基本查询
  • 从低星到4.5+:ASO优化如何重塑Google Play评分与用户信任
  • 【网络应用程序设计】实验四:物联网监控系统
  • Spring Cloud Gateway配置双向SSL认证(完整指南)
  • 算法题(133):二维差分
  • 银河麒麟(内核CentOS8)安装rbenv、ruby2.6.5和rails5.2.6
  • java—12 kafka
  • [特殊字符][特殊字符] HarmonyOS相关实现原理聊聊![特殊字符][特殊字符]
  • BY免费空间去掉?i=1
  • 使用eclipse将原有tomcat插件工程调整为的Dynamic Web Module工程(保姆级教程)
  • 原生微信小程序,canvas生成凭证,保存到手机
  • 数据结构-选择排序(Python)
  • 配置RSUniVLM环境(自用)
  • 多模态大模型 Qwen2.5-VL 的学习之旅
  • 无标注文本的行业划分(行业分类)算法 —— 无监督或自监督学习
  • 以太网的mac帧格式
  • 优化uniappx页面性能,处理页面滑动卡顿问题
  • 阿联酋启动第三届全球航空奖评选,奖金总额达百万美元
  • 龚曙光:散文家永远只有一个视角,就是“我与时代”
  • 技术派|“会飞的手榴弹”:微型无人机将深刻改变单兵作战方式
  • 嫦娥八号任务合作项目,这十个入选
  • 继续免费通行!五一假期全国高速公路日均流量约6200万辆
  • 北大强基计划招生简章发布,笔试部分考试科目有变化