微步在线云API
我的API

提交URL分析

通过 11 款URL扫描引擎和 URL/域名黑名单服务对任意 URL 进行检测，同时对 URL 下载的文件进行分析，生成URL扫描分析报告。

调用脚本
Run In Postman
请求方式
请求地址： https://api.threatbook.cn/v3/url/scan

请求方式：POSTGET

使用说明

适用场景： 该接口适用于提交 URL 进行扫描，可用于邮件链接检测、IM 链接检测、Web 访问风险分析和可疑 URL 初步处置。相关场景示例可参考：IM/邮件防钓鱼。

使用建议： 建议在需要对 URL 发起最新扫描时调用。该接口主要用于提交扫描任务并返回报告入口；若需要查看 URL 的扫描引擎结论、下载文件分析结果和 HTTP 响应信息，应继续调用 URL 信誉报告接口。

响应字段解读建议： 建议重点保存 url、time 和 permalink，用于确认扫描对象、扫描时间和报告访问入口。风险判断应以后续 URL 信誉报告中的 threat_level、multiengines、sandbox 和 details 为准。

请求参数说明
序号参数名称必选类型描述
1apikey是stringAPI请求的身份识别标识。
2url是string请求扫描的URL。
响应参数说明
序号参数名称类型描述使用说明
1response_codeint响应正常会返回"0"。
其他Response code及对应msg描述参见"响应Code和Msg对照表"		用于判断本次请求是否成功。业务系统应先判断该字段，再解析 data 内的业务结果；非 0 时建议按异常请求处理。
2verbose_msgstring响应正常会返回"Ok"。
其他Response code及对应msg描述参见"响应Code和Msg对照表"		用于展示或记录接口返回说明，适合写入调用日志和错误排查信息；自动化流程建议以 response_code 为主要判断依据。
3urlstring请求扫描的URL用于确认实际提交扫描的 URL，适合在工单、日志和报告中留存。
4timestring扫描时间用于记录扫描时间，帮助区分历史扫描和本次扫描。
5permalinkstringWeb 报告地址用于跳转到沙箱报告页，适合人工复核和报告留存。
请求示例

微步在线云API支持cURL、Python、PHP、Java、Go语言的请求，以Python为例：

Python
import requests

url = "https://api.threatbook.cn/v3/url/scan"
data = {
  "apikey": "请替换apikey",
  "url": "https://s.threatbook.com"
}
response = requests.post(url, data=data)
print(response.json())
响应示例（JSON）
{
  "response_code": 0,
  "verbose_msg": "OK",
  "data":{
    "url": "https://s.threatbook.com",     // 扫描 URL
    "time": "2019-01-28 20:33:28",        // 扫描时间
    "permalink": "https://s.threatbook.com/report/url/{md5}"       // Web 报告地址
  }
}
云API是北京微步在线科技有限公司旗下产品了解微步在线《用户服务条款》《数据保护政策》联系我们：api@threatbook.cn
Copyright © ThreatBook.CN All Rights Reserved. 京ICP备15044984号-4 北京微步在线科技有限公司 京公网安备11010802025715号