API接口的对接一般需要以下步骤:
确定API的基本信息:包括API的名称、版本号、请求地址、请求方法、请求参数、响应数据格式等。
申请API的访问权限:许多API需要进行用户认证、鉴权等操作,需要申请相应的API密钥或token,以获取API的访问权限。
编写API对接代码:根据API的基本信息,编写对接接口的代码,以实现请求参数的封装、请求发送、响应数据的解析等操作。
测试API接口:在对接完成后,需要进行API接口的测试,以验证接口的正确性、稳定性等。
上线API接口:完成测试后,可以将API接口上线,供其他系统或应用使用。在上线后,需要维护API接口的稳定性和安全性,及时修复漏洞和更新API版本。
需要注意的是,不同的API接口可能对接方式有所不同,具体对接方式需要结合具体的API接口文档进行实现。
一、API接口是什么? 我们来以一个常见的数学公式理解API,比如y=x+2,当x=2的时候,y=4,对么?
那此时,我们把y=x+2称为接口,x=2称为参数,y=4称为返回结果,那这个接口的功能就是能把我们输入的数加上2(注意:这里你可以发现接口自身是带有逻辑的)。
类比地,我们来理解一个常见的场景,比如现在有一个可以把经纬度转化为城市的接口,那当我输入经度是55°,纬度是88°的时候,接口通过自己的逻辑运算,返回结果告诉我:杭州市。
这样你就可以清晰地了解百度百科的官方解释了,接口就是预先定义的函数逻辑,他是供其他系统请求,然后返回结果的一个东西。
二、为什么我们需要API接口? 背景:我们的业务系统涉及多方多面,如果要一个公司或者一个系统把所有业务都做完,那未免工作量太大了吧?并且如果其他系统或公司有更好的运算逻辑,那我们在设计功能的时候可以考虑利用接口进行开发。
核心需求:利用现有接口可以降低开发成本,缩短开发成本。
举个例子:比如我是打车的APP,现在我需要在我的页面上展现地图的功能,对于我司而言,新做地图功能未免成本过高,那我们可以在高德开放平台或者百度地图的开放平台,找到地图API,这样的话我们只需要购买高德的服务,部署调用高德地图API,这样就可以快速在我们页面上线地图功能了。
三、API接口的核心 对于小白而言,初看API文档可能是一头雾水的——从哪里看,怎么看,看什么是摆在面前的问题。
其实对于产品经理而言,我们应该更关注这个公司可以提供什么样的API接口服务,比如我知道高德可以提供地图API,规划路线的API,这样的话在我们设计功能和工作中就可以想到调用他们的服务或者参考。
所以产品小白们看不懂也不用过于担心,未来工作中你也会更深入了解清楚,因为看懂并不复杂,以下是API接口的核心点,所有的说明文档离不开这5个核心点。
以下说明均以微信开放平台为例说明,文末有各开放平台的地址,大家有空可以去学习。好了,事不宜迟,现在我们来建立一个场景。
我们现在有一个APP,需要用户在购买的时候调起微信支付的API,完成购买。请各位自动进入这个场景,把自己当作一位产品经理。
"item_weight": "",
"post_fee": "",
"express_fee": "",
"ems_fee": "",
"shipping_to": "",
"video": [],
"sample_id": "",
"props_name": "0:0:机身内存:64GB;1:0:颜色:铁灰色;1:1:颜色:瓷白色",
"prop_imgs": {
"prop_img": []
},
"property_alias": "0:0:64GB;1:0:铁灰色;1:1:瓷白色",
"props": [
{
"name": "品牌",
"value": "多亲"
},
{
"name": "型号",
"value": "Qin 2 Pro"
},
{
"name": "手机类型",
"value": "老人手机"
},
{
"name": "外形",
"value": "直板"
},
{
"name": "主屏尺寸",
"value": "大屏幕(5.0英寸—5.9英寸)"
},
{
"name": "网络制式",
"value": "移动4G(TD-LTE),联通/电信4G(FDD-LTE)"
},
{
"name": "操作系统",
"value": "Android 9.0系统"
},
{
"name": "电池容量",
"value": "2100"
},
{
"name": "摄像头像素",
"value": "1200万-1999万"
},
{
"name": "存储卡",
"value": "支持存储卡"
},
{
"name": "处理器核心",
"value": "八核"
},
{
"name": "运行内存",
"value": "2GB"
},
{
"name": "手机版本",
"value": "大陆行货"
},
{
"name": "售后类型",
"value": "全国联保"
},
{
"name": "上市时间",
"value": "2019"
},
{
"name": "适用送礼场合",
"value": "员工福利,颁奖纪念,广告促销,节日,展销会,公关策划,生日,商务馈赠"
},
{
"name": "3C证书编号",
"value": "2019161606319519"
},
{
"name": "CPU品牌",
"value": "展讯"
},
{
"name": "运营商",
"value": "中国移动,中国电信,中国联通"
},
{
"name": "网络模式",
"value": "单卡单模"
},
{
"name": "机身内存",
"value": "64GB"
},
{
"name": "颜色",
"value": "铁灰色,瓷白色"
},
{
"name": "电信设备进网许可证编号",
"value": "02-B613-192425"
}
],
"total_sold": "1",
"scale": "",
"sellUnit": "",
"skus": {
"sku": [
{
"price": "799.00",
"total_price": 0,
"sales": "55",
"properties": "0:0;1:1",
"properties_name": "0:0:机身内存:64GB;1:1:颜色:瓷白色",
"quantity": "932",
"sku_id": "4309097072612",
"spec_id": "63828b15ad641fdb131775f32e4c050c"
},
{
"price": "799.00",
"total_price": 0,
"sales": "159",
"properties": "0:0;1:0",
"properties_name": "0:0:机身内存:64GB;1:0:颜色:铁灰色",
"quantity": "831",
"sku_id": "4302217872901",
"spec_id": "0eb631954bfe8fb00a45824fc6193f2f"
}
]
},
"seller_id": "2206619673102",
"sales": 30,
"shop_id": "",
"props_list": {
"0:0": "机身内存:64GB",
"1:0": "颜色:铁灰色",
"1:1": "颜色:瓷白色"
},
"seller_info": {
"nick": "qin多亲科技",
"user_num_id": "2206619673102",
"sid": "b2b-2206619673102e9470",
"title": "深圳多亲科技实力卖场",
"zhuy": "https://winport.m.1688.com/page/index.html?memberId=b2b-2206619673102e9470",
"shop_name": "qin多亲科技"
},
"tmall": "",
"data_from": "1688app",
"error": "",
"unit": "部",
"is_support_mix": null,
"mix_amount": null,
"mix_begin": null,
"mix_number": null,
"min_num": "2",
"sales_data": "",
"location": "广东省 深圳市",
"props_img": [],
"sales_info": {
"seller_num": "",
"repeat_rate_purchase": "",
"per_capita_purchases": "",
"comment_num": "",
"comment_url": ""
},
"desc_img": [
"https://cbu01.alicdn.com/img/ibank/2020/560/807/14112708065_979836901.jpg",
"https://cbu01.alicdn.com/img/ibank/2020/303/507/14112705303_979836901.jpg",
"https://cbu01.alicdn.com/img/ibank/2020/499/812/14150218994_979836901.jpg",
"https://cbu01.alicdn.com/img/ibank/2020/770/128/14199821077_979836901.jpg",
"https://cbu01.alicdn.com/img/ibank/2020/588/942/13197249885_979836901.jpg",
"https://cbu01.alicdn.com/img/ibank/2020/778/789/13234987877_979836901.jpg",
"https://cbu01.alicdn.com/img/ibank/2020/109/489/13234984901_979836901.jpg",
"https://cbu01.alicdn.com/img/ibank/2020/156/072/13197270651_979836901.jpg",
"https://cbu01.alicdn.com/img/ibank/2020/270/710/13235017072_979836901.jpg",
"https://cbu01.alicdn.com/img/ibank/2020/735/999/13234999537_979836901.jpg",
"https://cbu01.alicdn.com/img/ibank/2020/549/252/13197252945_979836901.jpg",
"https://cbu01.alicdn.com/img/ibank/2020/409/552/13197255904_979836901.jpg",
"https://cbu01.alicdn.com/img/ibank/2020/247/935/13278539742_979836901.jpg",
"https://cbu01.alicdn.com/img/ibank/2020/355/845/13278548553_979836901.jpg",
"https://cbu01.alicdn.com/img/ibank/2020/917/372/13197273719_979836901.jpg",
"https://cbu01.alicdn.com/img/ibank/2020/969/099/13234990969_979836901.jpg",
"https://cbu01.alicdn.com/img/ibank/2020/175/455/13278554571_979836901.jpg",
"https://cbu01.alicdn.com/img/ibank/2020/427/386/13314683724_979836901.jpg",
"https://cbu01.alicdn.com/img/ibank/2020/331/365/13278563133_979836901.jpg",
"https://cbu01.alicdn.com/img/ibank/2020/654/500/13235005456_979836901.jpg",
"https://cbu01.alicdn.com/img/ibank/2020/542/110/13235011245_979836901.jpg",
"https://cbu01.alicdn.com/img/ibank/2020/291/020/13235020192_979836901.jpg",
"https://cbu01.alicdn.com/img/ibank/2020/329/635/13278536923_979836901.jpg",
"https://cbu01.alicdn.com/img/ibank/2020/996/155/13278551699_979836901.jpg",
"https://cbu01.alicdn.com/img/ibank/2020/230/920/13235029032_979836901.jpg",
"https://cbu01.alicdn.com/img/ibank/2020/464/972/13197279464_979836901.jpg",
"https://cbu01.alicdn.com/img/ibank/2020/380/275/13278572083_979836901.jpg",
"https://cbu01.alicdn.com/img/ibank/2020/999/462/13197264999_979836901.jpg",
"https://cbu01.alicdn.com/img/ibank/2020/868/245/13278542868_979836901.jpg",
"https://cbu01.alicdn.com/img/ibank/2020/843/410/13235014348_979836901.jpg",
"https://cbu01.alicdn.com/img/ibank/2020/897/200/13235002798_979836901.jpg",
"https://cbu01.alicdn.com/img/ibank/2020/914/800/13235008419_979836901.jpg",
"https://cbu01.alicdn.com/img/ibank/2020/709/762/13197267907_979836901.jpg",
"https://cbu01.alicdn.com/img/ibank/2020/427/545/13278545724_979836901.jpg",
"https://cbu01.alicdn.com/img/ibank/2020/741/003/13197300147_979836901.jpg",
"https://cbu01.alicdn.com/img/ibank/2020/175/710/13235017571_979836901.jpg",
"https://cbu01.alicdn.com/img/ibank/2020/410/485/13278584014_979836901.jpg",
"https://cbu01.alicdn.com/img/ibank/2020/863/665/13278566368_979836901.jpg"
],
"shop_item": [],
"relate_items": []
},
"secache": "f75c59301daa3fc1610a8563c998f851",
"secache_time": 1608276252,
"secache_date": "2020-12-18 15:24:12",
"translate_status": "",
"translate_time": 0,
"language": {
"default_lang": "cn",
"current_lang": "cn"
},
"error": "",
"reason": "",
"error_code": "0000",
"cache": 0,
"api_info": "today:12 max:10000",
"execution_time": 6.65,
"server_time": "Beijing/2020-12-18 15:24:17",
"client_ip": "182.111.155.89",
"call_args": {
"num_iid": "610947572360",
"area_id": "440111"
},
"api_type": "1688",
"translate_language": "zh-CN",
"translate_engine": "google_cn",
"server_memory": "4.44MB",
"request_id": "gw-2.5fdc591b3bdb0"