# 本地服务指南
【API开发者】微信交流群
扫码进群
扫码进群
【脚本开发定制】微信交流群
扫码进群
扫码进群
# 1.简介
1.1.提供一套标准化的程序接口,支持本地化API调用,浏览器的启动与终止、账号配置信息的读取与写入等基础功能模块,具体详见:【API接口文档】
1.2.可以配合Selenium、Puppeteer和playwright等自动化框架,实现浏览器操作的自动化管理
1.3.接口有请求频率限制,每个接口每分钟调用次数有限,具体请参考客户端系统设置的Local API
# 2.使用方式(仅支持智纹V3.2.2及以上客户端版本)
2.1.有界面模式,只需要通过接口直接调用API即可
2.2.无界面模式,点击API访问凭据,开启鉴权控制,获取appId和appSecret,具体详见:【无界面模式】
# 3.接口使用概述
- Local Api的所有接口的参数传递方式为body传参,json格式,不接受request url、formdata、string等类型传参方式。
- 无界面模式请求参数的请求体需携带signature字段
- signature=MD5(DM5(appId+appSecret)),即把appId+appSecret进行MD5加密,再进行MD5加密,得到32位的小写签名
- 接口返回json对象,success为true作成功,如有返回数据,附加在data对象中
- 接口返回success为false时,表示业务失败,可能为程序原因,或参数校验等原因,失败信息会附加到msg中
- 建议使用postman或者Apifox调试接口,调通后,再进行脚本开发调用
// success example
{
success: true,
data: {
id: '123',
groupName: '新建分组'
}
}
// failed example
{ success: false, msg: '分组id必传' }
# 4.JavaScript 示例代码
注意事项:
- 请先阅读demo里面的README文档,安装对应环境和依赖
- demo里的API参数仅作为演示使用,详细参数,请以API文档为准
# Apifox调试demo,直接导入即可
无界面模式 →