jqvisionVideo AI Open Platform
指南

快速开始

从申请密钥到拿到第一条检测结果，通常 5 分钟内完成。

1. 申请应用与密钥

在开发者控制台创建应用后，平台会返回一次性的 appSecret。这个密钥只在创建时明文返回一次，请立即保存到密钥管理系统；平台侧只保存 SM4 密文，任何人（包括我们）都无法再次读出。

2. 用服务端代签或自行签名

调试阶段可以直接调用 POST /api/v1/openapi/sign 由平台代签（appSecret 不出前端）；生产环境建议在自己的服务端按签名规范实现，签名口径在"签名规范"页逐字节给出。

curl（服务端代签后调用算法目录）
# 1) 取算法目录（GET 请求 body 为空）
curl -X POST 'https://your-host/api/v1/openapi/sign' \
  -H 'Content-Type: application/json' \
  -d '{"appKey":"AK_xxx","method":"GET","path":"/openapi/v1/algorithms"}'

# 2) 响应里的 canonical / signature 直接照着用
curl 'https://your-host/openapi/v1/algorithms' \
  -H 'X-App-Key: AK_xxx' \
  -H 'X-Timestamp: 1757750000000' \
  -H 'X-Nonce: 8f3c1d9a' \
  -H 'X-Signature: <上一步返回的 signature>'

3. 调用同步检测或创建长期任务

  • POST /openapi/v1/detect：同步单次检测，适合"看一眼就走"的场景；dryRun=true 只校验授权与算力归属，不消耗推理资源。
  • POST /openapi/v1/tasks：创建长期任务，配合 start / stop 管理，适合 7×24 值守。
  • GET /openapi/v1/stats/usage：查询自己应用的当日用量与配额水位。

4. 接收告警

在控制台配置 Webhook 订阅后，告警会以 HTTP POST 推送；每个回调都带 X-Jq-Timestamp 与 X-Jq-Signature，请在接收端校验签名与时间窗（±5 分钟），否则任何人都能伪造"入侵告警"。