API Docs
对外 API 文档
本页可直接照抄调用,包含每个接口的参数、默认值、返回和错误码。
基础信息
当前运行域名:https://1.wm5s.com
接口入口:https://1.wm5s.com/api.php
密钥 Header:X-API-Key
Query 传密钥:已关闭
Query 参数名:api_key
返回格式:JSON(UTF-8)
请按平台要求传递密钥:优先使用 Header 方式。
接入步骤
- 向平台管理员申请并开通 API 密钥。
- 请求时带上 Header:
X-API-Key: YOUR_API_KEY。 - 调用
v1_crawl提交任务,再用v1_queue_list/v1_queue_status查询进度。 - 完成后用
v1_tasks获取预览/下载地址。
通用响应
{
"code": 0,
"msg": "ok",
"data": {}
}
| 字段 | 类型 | 说明 |
|---|---|---|
code | int | 0=成功,1=入队成功,2=重复命中,-1=失败 |
msg | string | 提示信息 |
data | object/array | 业务数据,不同接口结构不同 |
错误码(HTTP)
| HTTP | 含义 | 常见原因 |
|---|---|---|
| 400 | 参数错误 | URL 无效、站点不可达、参数格式不合法 |
| 401 | 未认证 | 缺少密钥或密钥无效 |
| 403 | 无权限 | 密钥禁用、无接口权限、策略不允许 |
| 404 | 不存在 | act 不存在或队列 ID 不存在 |
| 405 | 方法不允许 | 例如 `v1_crawl` 必须使用 POST |
| 429 | 限流 | 每分钟请求超限、每日额度超限、队列上限超限 |
| 500 | 服务异常 | 服务器内部错误 |
POST
/api.php?act=v1_crawl
提交抓取任务
提交后返回队列任务 ID,后续用队列接口查询状态。
| 参数 | 位置 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
url | Body | 是 | - | 目标站点 URL,必须带 http/https |
mode | Body | 否 | auto | auto|wget|php |
asset_policy | Body | 否 | strict | strict|relaxed |
force | Body | 否 | 0 | 1 表示强制重抓(需密钥允许) |
# 最小请求
curl -X POST "https://1.wm5s.com/api.php?act=v1_crawl" \
-H "X-API-Key: YOUR_API_KEY" \
-d "url=https://example.com"
# 完整请求(包含可选参数)
curl -X POST "https://1.wm5s.com/api.php?act=v1_crawl" \
-H "X-API-Key: YOUR_API_KEY" \
-d "url=https://example.com" \
-d "mode=auto" \
-d "asset_policy=strict" \
-d "force=0"
GET
/api.php?act=v1_queue_status
查询单个队列任务状态
| 参数 | 位置 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
id | Query | 是 | - | 队列任务 ID(提交抓取时返回) |
curl -X GET "https://1.wm5s.com/api.php?act=v1_queue_status&id=YOUR_JOB_ID" \
-H "X-API-Key: YOUR_API_KEY"
GET
/api.php?act=v1_queue_list
查询当前密钥的队列任务列表
| 参数 | 位置 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
limit | Query | 否 | 20 | 返回条数,范围 1-50 |
# 最小请求(不带 limit)
curl -X GET "https://1.wm5s.com/api.php?act=v1_queue_list" \
-H "X-API-Key: YOUR_API_KEY"
# 可选:指定 limit
curl -X GET "https://1.wm5s.com/api.php?act=v1_queue_list&limit=12" \
-H "X-API-Key: YOUR_API_KEY"
GET
/api.php?act=v1_tasks
查询当前密钥的历史任务
该接口只返回当前密钥提交并完成的任务。
| 参数 | 位置 | 必填 | 默认值 | 说明 |
|---|---|---|---|---|
page | Query | 否 | 1 | 页码,从 1 开始 |
limit | Query | 否 | 10 | 每页条数,范围 1-50 |
# 最小请求(不带 page/limit)
curl -X GET "https://1.wm5s.com/api.php?act=v1_tasks" \
-H "X-API-Key: YOUR_API_KEY"
# 可选:分页参数
curl -X GET "https://1.wm5s.com/api.php?act=v1_tasks&page=1&limit=10" \
-H "X-API-Key: YOUR_API_KEY"
密钥配置概览
| 密钥ID | 状态 | 权限 | 每分钟 | 每日请求 | 每日抓取 | Active上限 |
|---|---|---|---|---|---|---|
| client_demo | 启用 | crawl, queue_status, queue_list, list | 60 | 5000 | 300 | 1 |
为安全起见,此页只显示密钥 ID 与限制策略,不显示真实密钥。