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

接口梳理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【消息队列/消息中间件】可以用于内部系统对接非实时部分,具体看研发设计。

相关推荐
copyer_xyf2 分钟前
Python 类全面总结
前端·后端·python
小此方2 分钟前
Re:Mysql数据库基础篇(二):MySQL 基础指南,架构分层、SQL 分类与引擎解析
数据库·mysql
一个儒雅随和的男子3 分钟前
深入剖析时序数据库 InfluxDB 核心原理
数据库·时序数据库
Nayxxu4 分钟前
GPT API 迁移教程:Chat Completions 到 Responses API 的最小改造路径
数据库·gpt
智慧景区与市集主理人6 分钟前
巨有科技乡村农文旅景区智慧建设|轻量化升级,激活乡村文旅长效增收动能
大数据·科技
copyer_xyf6 分钟前
Python 类型注解:从 TypeScript 迁移理解
前端·后端·python
27669582927 分钟前
谷歌google cookie逆向角度分析
开发语言·python·google·sgss·谷歌搜索·sg-ss·谷歌cookie逆向
05候补工程师7 分钟前
【期末/408冲刺】软件工程核心考点与大题通关秘籍(附图解与解题套路)
大数据·hadoop·经验分享·笔记·软件工程
minji...9 分钟前
MySQL数据库 (三) 表的操作(增删查改),库和表的关系
数据库·mysql·数据表
浩风祭月10 分钟前
Gemini 2.5 Flash Lite 轻量化智能应用实战指南
人工智能·自动化