API接口的核心
对于小白而言,初看API文档可能是一头雾水的——从哪里看,怎么看,看什么是摆在面前的问题。
其实对于产品经理而言,我们应该更关注这个公司可以提供什么样的API接口服务,比如我知道高德可以提供地图API,规划路线的API,这样的话在我们设计功能和工作中就可以想到调用他们的服务或者参考。
所以产品小白们看不懂也不用过于担心,未来工作中你也会更深入了解清楚,因为看懂并不复杂,以下是API接口的核心点,所有的说明文档离不开这5个核心点。
以下说明均以微信开放平台为例说明,文末有各开放平台的地址,大家有空可以去学习。
1. 接口地址
2. 请求参数(报文)
3. 返回结果
(1)成功
(2)失败
四、API接口的应用
举例:
创建标签
简要描述:
- 添加标签
请求URL:
http://域名地址/addContactLabel
请求方式:
- POST
请求头Headers:
- Content-Type:application/json
- Authorization:login接口返回
参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
wId | 是 | String | 登录实例标识 |
labelName | 是 | String | 标签名称 |
请求参数示例
{
"wId":"349be9b5-8734-45ce-811d-4e10ca568c67",
"labelName": "看一看世界"
}
成功返回示例
{
"message": "成功",
"code": "1000",
"data": {
"labelId": 3,
"labelName": "看一看世界"
}
}
错误返回示例
{
"message": "失败",
"code": "1001",
"data": null
}
返回数据:
参数名 | 类型 | 说明 |
---|---|---|
code | String | 1000成功 1001失败 |
msg | String | 反馈信息 |
data | JSONObject |