• 电商产品|如何读懂API接口


    对于很多产品小白或求职者而言,API接口是一个产品和研发领域的专业术语,大家可能在文章或者PRD中都已经有接触过API接口的概念。

    实际上,接口的应用已经非常广泛和成熟,这个概念主要活跃在公司内部的各系统之间的衔接和对接以及公司间合作的场景,所以了解API是非常重要的;

    1

    什么是API接口

    API,全称是Application Programming Interface,即应用程序编程接口,我们日常中习惯简称为“接口”。

    顾名思义接口就是传输和储存数据的,那么具体是什么呢就比如生活中的USB接口;API事实上是在内部预先定义了函数,能够使开发人员无须明白API内部实现的机制,就能够实现某一个功能。

    在我们设计产品时如果自己做不出来,或者说做起来太麻烦浪费物力就可以选择通过第三方的去找接口;比如手机注册时需要获取雁阵吗,那么我们需要提供一个手机注册的接口,前端人员在调用接口去实现功能是,按照接口的规则进行请求就可以了;所以我们可以简单的理解为“接口决定了功能”

     

    2

    如何读懂API文档

    对于小白而言,初看API文档可能是一头雾水的——从哪里看,怎么看,看什么是摆在面前的问题。

    其实对于产品经理而言,我们应该更关注这个公司可以提供什么样的API接口服务,比如我知道高德可以提供地图API,规划路线的API,这样的话在我们设计功能和工作中就可以想到调用他们的服务或者参考。

    所以产品小白们看不懂也不用过于担心,未来工作中你也会更深入了解清楚,因为看懂并不复杂,以下是API接口的核心点,所有的说明文档离不开这6个核心点。

    电商API接口地址

    接口地址就是这条链接传输的指定数据,比如用户点击付款,我们需要搞碎微信,我们徐亚使用支付功能,而地址就是我们要传输的主要数据的对象;

    请求参数

    那我们将数据传输之后,接下来就需要告诉微信,我们需要调用收银台,也就是我们需要告诉这个接口的内容是什么?具体如下图所示

    名称类型必须描述
    keyString调用key(必须以GET方式拼接在URL中)
    secretString调用密钥
    api_nameStringAPI接口名称(包括在请求地址中)[item_search,item_get,item_search_shop等]
    cacheString[yes,no]默认yes,将调用缓存的数据,速度比较快
    result_typeString[json,jsonu,xml,serialize,var_export]返回数据格式,默认为json,jsonu输出的内容中文可以直接阅读
    langString[cn,en,ru]翻译语言,默认cn简体中文
    versionStringAPI版本

    请求参数

    请求参数: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

    Bigint029186819959商品ID

    title

    String0MOCO2018夏季新品时尚V领条纹连衣裙 摩安珂 蓝白条色 S商品标题

    desc_short

    String0商品简介

    price

    Float0719.0价格

    total_price

    Float00

    suggestive_price

    Float00

    orginal_price

    Float01199.00原价

    nick

    String0MO&Co.官方旗舰店掌柜昵称

    num

    Int0999

    min_num

    Int00

    detail_url

    String0http://item.jd.com/29186819959.html商品链接

    pic_url

    String0//img14.360buyimg.com/n0/jfs/t22033/147/1051007175/85125/c44dd0df/5b1f2855Ncbe35858.jpg商品图片

    brand

    String0品牌名称

    brandId

    Int0品牌ID

    rootCatId

    Int01343顶级分类ID

    cid

    Int09719

    crumbs

    Mix0[]

    created_time

    String0

    modified_time

    String0

    delist_time

    String0

    desc

    String0

    desc_img

    Mix0[]

    item_imgs

    Mix0[{ "url": "//img14.360buyimg.com/n0/jfs/t22033/147/1051007175/85125/c44dd0df/5b1f2855Ncbe35858.jpg"}]商品图片

    item_weight

    String0

    item_size

    String0

    location

    String0发货地

    post_fee

    Float06.00物流费用

    express_fee

    Float06.00快递费用

    ems_fee

    Float06.00EMS费用

    shipping_to

    String0发货至

    has_discount

    Boolean0false

    video

    Mix0[]商品视频

    is_virtual

    String0

    sample_id

    String0商品风格标识ID

    is_promotion

    Boolean0

    props_name

    String00:0:尺码:S;0:1:尺码:XS;0:2:尺码:M;0:3:尺码:L;0:4:尺码:XL商品属性名

    prop_imgs

    Mix0{"prop_img": []}商品属性图片列表

    property_alias

    String00:0:S;0:1:XS;0:2:M;0:3:L;0:4:XL商品属性别名

    props

    Mix0[{ "name": "尺码","value": "S XS M L XL" }]商品详情

    total_sold

    Int0

    skus

    Mix0{"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

    Int0卖家ID

    sales

    Int0销量

    shop_id

    Int0店铺ID

    props_list

    Mix0{"0:0": "尺码:S"}商品属性

    seller_info

    Mix0{"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

    Boolean0false是否天猫

    error

    String0错误信息

    warning

    String0警告信息

    url_log

    Mix0[]

    props_img

    Mix0[]属性图片

    shop_item

    Mix0[]

    relate_items

    Mix0[]

     

    请求参数都分为 5 列:字段、说明、类型、备注、是否必填字段:

    类的属性说明:中文释义;

    类型:属性类型;

    备注:一些解释,或者可以写一下例子,比如负责 json 结构的情况,最好写上例子(这里不是产品写),好让前端能更好理解;

    是否必填:字段的是否必填。

    返回结果

  • 相关阅读:
    (仿牛客社区项目)Java开发笔记7.8:将文件上传至服务器
    .[nicetomeetyou@onionmail.org].faust勒索病毒数据怎么处理|数据解密恢复
    如何将本地的项目上传到Git
    母婴店做微信小程序开发的重要性
    独立产品灵感周刊 DecoHack #029 - 随便逛逛谷歌街景
    Tomcat部署及优化
    性能测试常见的测试指标
    27.CSS粒子特效
    【block作为函数参数的应用案例之一 Objective-C语言】
    MyBatis choose、when和otherwise标签简介说明
  • 原文地址:https://blog.csdn.net/2301_79478575/article/details/133983394