跳转到正文
IsSafeSite

API 文档

通过 REST API 发起扫描、查看结果并获取报告。

身份验证

在请求中添加 Authorization: Bearer <API_KEY>。请妥善保管密钥,不要在客户端代码中公开。

在控制台 → 设置 → API 密钥中创建密钥。

curl -H "Authorization: Bearer YOUR_API_KEY" https://issafesite.com/api/v1/scan

基础地址

https://issafesite.com/api/v1

速率限制

免费版:每天 3 次扫描、每分钟 10 次 API 请求;Pro:每天 50 次扫描、每分钟 60 次请求;Team:不限扫描次数、每分钟 300 次请求。

套餐详情每日扫描每分钟请求
Free310
Pro5060
Team∞300

接口

POST /api/v1/scan 创建扫描;GET /api/v1/scan 获取扫描列表。请求和响应使用 JSON。

POST /api/v1/scan

POST 请求体必须包含 url;depth 可选 QUICK、STANDARD(默认)或 DEEP。列表接口可使用 page(默认 1)和 limit(默认 20,最多 50);报告列表还可用 scanId 过滤。

curl -X POST https://issafesite.com/api/v1/scan \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","depth":"STANDARD"}'

202 · 已创建

GET /api/v1/scan

参数: 页码=1, 每页数量=20 (≤50)

curl -H "Authorization: Bearer YOUR_API_KEY" "https://issafesite.com/api/v1/scan?page=1&limit=10"

GET /api/v1/report

参数: scanId, 页码, 每页数量

curl -H "Authorization: Bearer YOUR_API_KEY" "https://issafesite.com/api/v1/report?scanId=clx1abc"

错误响应

成功创建扫描返回 202,列表返回 200。错误响应为包含 error 字段的 JSON;401 表示缺少密钥,403 表示密钥无效或过期。

{ "error": "..." }
400请求参数缺失或无效
401缺少 API 密钥
403密钥无效或已过期
429超过速率限制或套餐配额
500服务器内部错误

快速开始

通过 REST API 发起扫描、查看结果并获取报告。

curl -X POST https://issafesite.com/api/v1/scan \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","depth":"STANDARD"}'

支持

GET /api/v1/report 获取报告。调用前请查看套餐限额;遇到认证、参数或限流错误时,检查 HTTP 状态码和响应内容。

support@issafesite.com

查看英文原版的完整细节