网页可读内容抽取 - 咕咕数据 API 文档

网页可读内容抽取
接口详情官网地址: https://www.gugudata.com/api/details/readability

网页正文智能抽取与结构化

请求方法: POST
接口路径: /websitetools/readability
调试地址: https://api.gugudata.com/websitetools/readability/demo
OpenAPI: https://www.gugudata.com/openapi/gugudata.openapi.3.1.json

请求参数:

appkey (string, 必填): 付费后获取的 APPKEY，在 JSON 请求体中传入。

url (string, 可选): 待抽取的网页 URL；url 与 html 至少传入一个。

html (string, 可选): 待抽取的 HTML 原文；url 与 html 至少传入一个。

返回字段:

DataStatus.RequestParameter: 本次请求的参数摘要字符串。

DataStatus.StatusCode: 接口返回状态码。

DataStatus.Status: 接口返回状态，例如 SUCCESS 或 ERROR。

DataStatus.StatusDescription: 接口返回状态说明。

DataStatus.ResponseDateTime: 接口数据返回时间。

DataStatus.DataTotalCount: 此条件下的数据总量；对象型结果通常为 1，列表型结果为列表数量或分页总数。

Data.Title: 网页标题。

Data.Byline: 作者或署名信息。

Data.Dir: 文本方向。

Data.Lang: 网页语言。

Data.Content: 抽取后的正文 HTML。

Data.TextContent: 抽取后的纯文本正文。

Data.Length: 纯文本正文长度。

Data.Excerpt: 正文摘要。

Data.SiteName: 站点名称。

Data.PublishedTime: 发布时间。

HTTP 状态码:

200 接口正常响应: 业务状态码请结合响应体中的状态字段判断。

400 请求参数错误: 参数缺失、格式错误或非法组合。

401 鉴权失败: 缺少 APPKEY 或 APPKEY 无效。

403 无权限或额度不可用: 订单到期、权限不足或剩余额度不可用。

404 资源不存在: 请求路径不存在。

405 请求方法不允许: 请求方法与接口定义不匹配。

415 请求内容类型不支持: 文件上传或请求体格式不符合要求。

429 请求频率超限: 触发接口或网关限流策略。

500 服务内部异常: 服务执行异常，请联系技术支持。

502 上游依赖异常: 上游服务响应异常或暂不可用。

业务状态码:

200 正常返回: 暂无说明

400 参数错误: 暂无说明

429 请求频率受限: 每秒请求不能超过 100 次

403 账号欠费: 请及时关注订单到期短信提醒

402 APPKEY 错误: 请检查传递的 APPKEY 是否为开发者中心获取到的值

500 接口响应错误: 暂无说明

接口特性:

支持从 URL 或 HTML 中抽取网页主体可读内容；

url 与 html 至少传入一个，传入 html 时可减少外部网页访问的不确定性；

返回正文 HTML、纯文本、摘要、标题、站点名和发布时间等字段；

适合网页正文抓取、内容清洗、摘要生成前处理和知识库入库等场景；

围绕“网页可读内容抽取”提供标准化能力，便于快速接入现有业务；

适合将“网页可读内容抽取”结果接入业务系统、后台工具和自动化流程；

适合 SEO 分析、竞品研究、内容归档和站点巡检场景；

可与网页截图、正文抽取、链接提取和域名检测接口组合；

全接口支持 HTTPS（TLS v1.0 / v1.1 / v1.2 / v1.3）；

全面兼容 Apple ATS；

全国多节点 CDN 部署；

接口调用状态与状态监控：https://www.gugudata.com/status。

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

接口正常响应。请求成功，业务状态请结合响应体中的自定义业务码判断。

Bodyapplication/json

示例

{
    "DataStatus": {
        "RequestParameter": "string",
        "StatusCode": 0,
        "Status": "string",
        "StatusDescription": "string",
        "ResponseDateTime": "string",
        "DataTotalCount": 0
    },
    "Data": {
        "Title": "string",
        "Byline": "string",
        "Dir": "string",
        "Lang": "string",
        "Content": "string",
        "TextContent": "string",
        "Length": 0,
        "Excerpt": "string",
        "SiteName": "string",
        "PublishedTime": "string"
    }
}

🟠400

🟠401

🟠403

🟠404

🟠405

🟠415

🟠429

🔴500

🔴502