API接口是预先定义的函数,允许应用间共享数据和功能。对接API涉及获取接口文档,通过POST请求调用如http://域名地址/queryLoginWx的URL,使用特定Headers。成功返回会包含状态码、消息和数据,如微信id和登录实例标识。
一、API接口是什么?
API接口即应用编程接口,是一些预先定义的函数,可以提供应用程序与开发人员基于某软件或硬件以访问一组例程的能力。简单来说,API接口相当于信息的桥梁,它可以让不同平台、应用程序或系统共享数据,相互通信,当你的应用或系统缺少某种数据或功能,通过API接口可以调用平台数据或其他系统已开发好的功能,缩短开发时间并降低成本。
二、怎么对接API?
对接API,首先要拿到接口文档和接口代码示例,很多平台都有自己的开放平台,
拿到了API接口文档,需要开发人员联调测试上线。
API进行测试
简要描述:
此接口应用场景是查询在线的wid和wcid列表
请求URL:
http://域名地址/queryLoginWx
请求方式:
POST
请求头Headers:
Content-Type:application/json
Authorization:login接口返回
无参数:
返回数据:
参数名 类型 说明
code string 1000成功(在线),1001失败(离线)
message string 反馈信息
wcId string 微信id
wId string 登录实例标识
请求参数示例
{
}
成功返回示例
{
“code”: “1000”,
“message”: “成功”,
“data”: [
{
“wcId”: “wxid_i6qsbbjenju2”,
“wId”: “72223018-7f2a-4f4f-bfa3-26e47dbd61”
}
]
}
失败返回示例
{
“code”: “1001”,
“message”: “失败”
}
————————————————