API 接口文档

本章节介绍沙特协作的服务端接口规范,以及三种 App 端接入模式的详细接入步骤。

基础信息

  • 协议:HTTP/1.1
  • 数据格式:JSON
  • 字符编码:UTF-8
  • 基础路径https://<服务器IP>/shater

三种抓包模式概览

沙特协作提供 3 种抓包模式,App 端根据需要选择其一即可:

模式适用场景App 改动量是否需要 CA 证书是否需要修改请求地址
直接扫码(直连上报)App 已有 HTTP 拦截能力🟢 小(仅在拦截器上报)❌ 不需要❌ 不需要
反向代理扫码App 启用了 SSL Pinning,常规抓包失败🟡 中(仅替换 baseURL)❌ 不需要✅ 需要
代理模式任意 App(未做防代理)🟢 无(系统级代理)✅ 需要❌ 不需要

📌 推荐顺序:直接扫码 > 反向代理扫码 > 代理模式

三种模式选择决策树

你的 App 是哪种情况?

├── 有源码,能改拦截器?
│   └── ✅ 使用【直接扫码】模式
│       改动最小,无需证书

├── 有源码,但启用了 SSL Pinning?
│   └── ✅ 使用【反向代理扫码】模式
│       改 baseURL 即可,无需证书

├── 没有源码(第三方 App)?
│   └── ⚠️ 使用【代理模式】
│       需要安装 CA 证书,可能受 SSL Pinning 限制

└── 抓 HTTPS Web(H5 页面)?
    └── ✅ 使用【代理模式】
        浏览器接受 CA 证书

文档导航

接入模式

HTTP 接口

其他

下一步