# 本地服务指南

【API开发者】微信交流群
扫码进群
【脚本开发定制】微信交流群
扫码进群

# 1.简介

1.1.提供一套标准化的程序接口,支持本地化API调用,包括浏览器实例的启动与终止、账号配置信息的读取与写入等基础功能模块,具体详见:【API接口文档】
1.2.可以配合Selenium、Puppeteer和Playwright等自动化测试框架,实现浏览器操作的自动化管理
1.3.接口有请求频率限制机制,每个接口每分钟调用次数有限制,具体限制值请参考客户端系统设置中的Local API配置

# 2.使用方式(仅支持智纹V3.2.2及以上客户端版本)

2.1.有界面模式,只需要通过HTTP接口直接调用API即可
2.2.无界面模式,点击API访问凭据选项,开启鉴权控制功能,获取appId和appSecret身份凭证,具体操作步骤详见:【无界面模式】

# 3.接口使用概述

  • Local API的所有接口的参数传递方式为请求体(body)传参,使用JSON格式,不接受URL参数、form-data、string等类型传参方式。
  • 无界面模式请求参数的请求体中需携带signature签名字段
  • signature=MD5(MD5(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接口文档为准

node-js调用示例.zip16MB点击下载,解压即用

# Apifox调试demo,直接导入即可

智纹浏览器API.json70KB点击预览