首页 > 其他分享 >API接口的要素以及API的作用说明

API接口的要素以及API的作用说明

时间:2023-04-15 17:33:48浏览次数:29  
标签:要素 1627207 String 商品 接口 item API

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


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


接下来我会从三个方面说明,相信各位认真读完也能对API有一个更新的了解。


本文目录:


一、API接口是什么?


二、为什么我们需要API接口?


三、API接口的核心、


API接口是什么?


API接口:应用程序接口(API:Application Program Interface),它是一组定义、程序及协议的集合,通过 API 接口能够实现计算机软件和软件之间的相互通信。


其实换句话通俗点来说,就是将内部实现的功能封装起来,就像一个盒子一样只留出一个口子,人们接入这个口子那么也就能使用这个功能。


调用的人可以很方便使用这些功能,并且可以不需要知道这些功能的具体实现过程,接口API就是按照作者规定的流程去调用这些功能。


为什么我们需要API接口?


背景:我们的业务系统涉及到多方多面,如果要一个公司或者一个系统把所有业务都做完,那可想而知,工作量是相当之巨大,并且如果其他系统或公司有更好的运算逻辑,那我们在设计功能的时候可以考虑利用接口进行开发。


核心需求:利用现有接口可以降低开发的成本,缩短开发的成本。


API接口的核心


  1. 接口地址(私信v;1887028846)


2. 请求参数


名称 类型 必须 描述

key String 是 调用key(必须以GET方式拼接在URL中)

secret String 是 调用密钥

api_name String 是 API接口名称(包括在请求地址中)[item_search,item_get,item_search_shop等]

cache String 否 [yes,no]默认yes,将调用缓存的数据,速度比较快

result_type String 否 [json,jsonu,xml,serialize,var_export]返回数据格式,默认为json,jsonu输出的内容中文可以直接阅读

lang String 否 [cn,en,ru]翻译语言,默认cn简体中文

version String 否 API版本

请求参数:num_iid=652874751412&is_promotion=1


参数说明:num_iid:淘宝商品ID

is_promotion:是否获取取促销价



返回结果


名称 类型 必须 示例值 描述

item


item[] 1  宝贝详情数据

num_iid


Bigint 1 520813250866 宝贝ID

title


String 1 三刃木折叠刀过安检创意迷你钥匙扣钥匙刀军刀随身多功能小刀包邮 宝贝标题

desc_short


String 0  商品简介

promotion_price


Int 0  优惠价

price


Float 1 25.8 价格

total_price


Float 0 0

suggestive_price


Float 0 0

orginal_price


String 0 25.80 原价

nick


String 0 欢乐购客栈 掌柜昵称

num


Int 0 3836 库存

min_num


Int 0 0 最小购买数

detail_url


String 0 http://item.taobao.com/item.htm?id=520813250866 宝贝链接

pic_url


String 1 //gd2.alicdn.com/imgextra/i4/2596264565/TB2p30elFXXXXXQXpXXXXXXXXXX_!!2596264565.jpg 宝贝图片

brand


String 0 三刃木 品牌名称

brandId


Int 0 8879363 品牌ID

rootCatId


Int 0 50013886 顶级分类ID

cid


Int 1 50014822

crumbs


Mix 0 [] 导航菜单

created_time


String 0 更多接口v;18870288846

modified_time


String 0  

delist_time


String 0  

desc


String 0  商品详情

desc_img


Mix 0 [] 商品详情图片

item_imgs


Mix 0 item_imgs[] 商品图片

item_weight


String 0  

item_size


String 0  

location


String 0  发货地

express_fee


Float 0 0.00 快递费用

ems_fee


Float 0  EMS费用

post_fee


Float 0  物流费用

shipping_to


String 0  发货至

has_discount


Boolean 0 false 是否有优惠

video


video[] 0  商品视频

is_virtual


String 0  

sample_id


String 0  商品风格标识ID

is_promotion


Boolean 0 false 是否促销

props_name


String 0 1627207:1347647754:颜色分类:长方形带开瓶器+送工具刀卡+链子;1627207:1347647753:颜色分类:椭圆形带开瓶器+送工具刀卡+链子; 商品属性名。格式为pid1:vid1:name1:value1;pid1:vid2:name2:value2。

prop_imgs


prop_imgs[] 0  商品属性图片列表

property_alias


String 0 20509:9974422:36;1627207:28326:红色;20509:9975710:38;1627207:28326:红色;20509:9981357:40;1627207:28326:红色 销售属性值别名。格式为pid1:vid1:alias1;pid1:vid2:alia2。

props


Mix 0 [{ "name": "产地","value": "中国" }] 商品属性

total_sold


Int 0  

skus


skus[] 0  商品规格信息列表

seller_id


Int 0 2844096782 卖家ID

sales


Int 0 138 销量

shop_id


Int 0 151372205 店铺ID

props_list


Mix 0 {20509:9974422: 尺码:36} 商品属性

seller_info


seller_info[] 1  卖家信息

tmall


Boolean 0 false 是否天猫

error


String 0  错误信息

warning


String 0  警告信息

url_log


Mix 0 []

favcount


Int 0 0

fanscount


Int 0 0

method


String 0 item_tmall:pget_item

promo_type


String 0  

props_img


Mix 0 1627207:28326": "//img.alicdn.com/imgextra/i2/2844096782/O1CN01VrjpXt1zyCc9DvERE_!!2844096782.jpg 属性图片

shop_item


Mix 0 []

relate_items


Mix 0 []

文章内容有限,欢迎私信交流沟通!

标签:要素,1627207,String,商品,接口,item,API
From: https://blog.51cto.com/u_16033113/6192387

相关文章

  • 浅谈-api项目设计(上)
    从事api后端接口开发也有五六年时间了,都没有好好的整理下api项目架构模板以及如何从零开始设计。抽空写个文章记录下,顺便检查下自己对这块的理解,如有不正确的地方,欢迎底下友好交流。本文的目的是检查自己对架构设计的理解,思考架构设计的意义和常用的设计思想按照软件工程流程。......
  • Vue3组合API自动引入插件
    插件名:unplugin-auto-importurl:https://github.com/antfu/unplugin-auto-import安装1、下载插件npmiunplugin-auto-import-D2、配置vite.config.tsimportvuefrom'@vitejs/plugin-vue'import{defineConfig}from'vite'//引入插件,因为我使用的vite+ts,所以这里引......
  • 项目连接讯飞语音接口的相关操作
    相关操作在讯飞官网找到了这样一个语音听写模件,然后自己尝试着调用了这个语音接口,幸运地,成功调用到了这个语音接口,但是这个调用仅仅是在Java里面实现了,并没有实现在web里面,后续还会继续完善这个调用的!具体步骤1、进入到讯飞平台官网:https://www.xfyun.cn/选择注册一个帐号之后......
  • 通过OpenFeign远程调用同局域网的其他接口
    通过OpenFeign远程调用同局域网的其他接口需要的依赖<dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-openfeign</artifactId></dependency><!--feig......
  • 虾皮API接口根据关键词取商品列表(商品详情,库存,排序,价格...)返回值及说明
    参数说明通用参数说明version:API版本key:调用key,测试key:test_api_keyapi_name:API类型[item_search,item_get]cache:[yes,no]默认yes,将调用缓存的数据,速度比较快result_type:[json,xml,serialize,var_export]返回数据格式,默认为jsonlang:[cn,en,ru]翻译语言,默认cn简体中......
  • 虾皮API接口根据关键词取商品列表(商品详情,库存,排序,价格...)返回值及说明
    参数说明通用参数说明version:API版本key:调用key,测试key:test_api_keyapi_name:API类型[item_search,item_get]cache:[yes,no]默认yes,将调用缓存的数据,速度比较快result_type:[json,xml,serialize,var_export]返回数据格式,默认为jsonlang:[cn,en,ru]翻译语言,默认cn简体中文API:i......
  • 标准的WebApi应该有哪些元素
    提问标准的WebApi应该有哪些元素回答声明完整的响应码200,404,401,400添加Operation添加Tag聚合业务申明请求和响应类型标注参数来源FromHeader使用IActionResult代替ActionResult[Tag("查询类服务")][HttpGet,Route("mytoute",Name=nameof(GetSomething)......
  • 在Node.JS中,调用JShaman的Web API接口,加密JS代码。
    在Node.JS中,调用JShaman的WebAPI接口,加密JS代码。源码varjs_code=` functionNewObject(prefix) { varcount=0; this.SayHello=function(msg) { count++; alert(prefix+msg); } this.GetCount=function() { returncount; } } varobj=newNewO......
  • 如何在WPF中调用Windows 10/11 API(UWP/WinRT)
    最近在github上看到一个音乐播放器项目,dopamine(项目地址:https://github.com/digimezzo/dopamine-windows.git)在编译时,提示有一个库找不到  找了好一会,才发现这是调用了UWP的库。在最初Windows8出来时,这一套新的运行时叫WindowsRT,后面到Windows10时,改成了UWP。因为......
  • 驱动模块加载三要素例子
    #include<linux/kernel.h>#include<linux/module.h>#include<linux/cdev.h>#include<linux/fs.h>#defineHELLO_MAJOR250#defineHELLO_MINOR0#defineDEV_NUM1#defineDEV_NAME"hello_world&qu......