EchoScan API 接入指南

接入总览

EchoScan 的推荐接入链路是：浏览器端运行 Browser Verifier 获取 imprint，随后由你的服务端调用 Lite / Pro 报告接口完成业务判定。

浏览器端只负责采集与提交；报告查询和风控策略应放在服务端。

Browser Verifier

NPM (ESM)

npm install @echoscan/browser-verifier

import { createEchoScan } from '@echoscan/browser-verifier'

const { imprint } = await createEchoScan().run()
await fetch('/your-server/imprint', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({ imprint })
})

CDN (ESM / UMD)

<script type="module">
  import { createEchoScan } from 'https://cdn.echoscan.org/v1/echoscan.esm.js'
  const { imprint } = await createEchoScan().run()
  console.log(imprint)
</script>

<script src="https://cdn.echoscan.org/v1/echoscan.umd.js"></script>
<script>
  window.EchoScan.createEchoScan().run().then(({ imprint }) => console.log(imprint))
</script>

API 列表

Method	Path	Auth	用途
GET	/api/v1/system/health	None	健康检查
GET	/api/v1/fingerprint/public-key	None	提交前获取公钥
POST	/api/v1/fingerprint/submit-lite	None	提交指纹并返回 imprint
GET	/api/v1/fingerprint/report-lite/{imprint}	None	查询 Lite 报告
GET	/api/v1/fingerprint/report/{imprint}	X-API-Key	查询 Pro 报告
GET	/api/v1/fingerprint/imprint/{imprint}/history	X-API-Key	查询访问历史

cURL 示例

Lite 报告

curl "https://api.echoscan.org/api/v1/fingerprint/report-lite/fp_session_xxx"

Pro 报告

curl -H "X-API-Key: es_xxx_yyy" \
  "https://api.echoscan.org/api/v1/fingerprint/report/fp_session_xxx"

History

curl -H "X-API-Key: es_xxx_yyy" \
  "https://api.echoscan.org/api/v1/fingerprint/imprint/fp_session_xxx/history?days=7"

API Key 申请

1. 发送应用信息到 echoscan.org@gmail.com
2. 审核通过后发放 Pro key
3. Key 仅保存在服务端环境变量，不放前端