• API 功能

    • 通过公开网页 URL 提交可读内容抽取请求;
    • 直接提交 HTML 文本,整理已有页面内容;
    • 同时提交 URL 与 HTML 时优先处理 URL,便于保留统一的输入方式;
    • 返回抽取后的正文 HTML,供文章内容整理;
    • 返回纯文本,便于阅读、检索和后续文本处理;
    • 提供与返回纯文本对应的长度,便于检查内容规模;
    • 返回识别到的标题,便于文章列表展示;
    • 返回内容摘要,供归档列表和阅读预览使用;
    • 在页面能够提供时返回作者、站点名称等元数据,缺失时保留空值;
    • 在页面能够提供时返回语言、方向和发布时间信息,便于核对文章资料;
    • 支持表单和 JSON 请求,并提供 URL 与 HTML 两组公开输入示例;
    • 适用于项目自有或有权使用的内容归档与整理,不保证所有网页都可抽取;
    • 默认最大 QPS:5,可在开发者中心自助升级,月付年付订单接口调用次数不限。
    • 接口调用状态与状态监控
  • API 文档

    接口地址: https://api.gugudata.com/websitetools/readability

    返回格式: application/json; charset=utf-8

    请求方式: POST

    请求协议: HTTPS

    请求示例: https://api.gugudata.com/websitetools/readability?appkey=YOUR_APPKEY

    HTML 输入示例:未提供 URL 时使用以下 HTML;同时提供时优先处理 URL。

    {"html":"<html lang='zh'><head><title>文章整理示例</title></head><body><article><h1>文章整理示例</h1><p>整理项目自有文章,保留正文内容,便于阅读和归档。</p></article></body></html>"}

    数据预览: https://www.gugudata.com/preview/readability

    接口测试:  https://api.gugudata.com/websitetools/readability/demo

    OpenAPI: https://www.gugudata.com/openapi/gugudata.openapi.3.1.json

    请求参数(POST 请求参数以 application/x-www-form-urlencoded 格式、文件流以 formdata 格式传递,具体可参见下方示例代码)

    参数名 参数类型 是否必须 默认值 备注
    appkey string 是 无 开发者中心分配的 APPKEY;支持现有 Query、Body、Header 和 Bearer 鉴权。
    url string 否 无 公开 HTTP/HTTPS 网页地址;url 与 html 至少一项为非空字符串,同时提供时优先使用 URL,URL 无效时不转用 HTML。
    html string 否 无 待抽取的 HTML 字符串;未提供 URL 时使用,不执行其中的脚本。支持表单和 JSON。

    返回参数

    参数名 参数类型 备注
    DataStatus.RequestParameter string 本次实际业务请求参数,不包含鉴权凭据;Demo 展示对应样例输入。
    DataStatus.StatusCode integer 成功业务码为 100;错误码见说明。
    DataStatus.StatusDescription string 接口返回状态说明。
    DataStatus.ResponseDateTime string 接口数据返回时间。
    DataStatus.DataTotalCount integer 成功返回一个正文对象,值为 1。
    Data.Title string 识别到的标题;缺失时为空。
    Data.Byline string 作者信息;缺失时为空。
    Data.Dir string 文字方向;缺失时为空。
    Data.Lang string 页面语言;缺失时为空。
    Data.Content string 正文 HTML,作为文本返回。
    Data.TextContent string 正文纯文本;降级时最多 50,000 个 UTF-16 代码单元。
    Data.Length integer 返回纯文本的 UTF-16 代码单元数。
    Data.Excerpt string 内容摘要;缺失时为空。
    Data.SiteName string 站点名称;缺失时为空。
    Data.PublishedTime string 识别到的发布时间,可能为空;缺失时为空。
  • 鉴权方式

    接口支持以下 AppKey 传递方式,任选一种即可;已有请求示例、Postman 集合和历史代码仍可继续使用原来的 appkey 参数方式。

    传输载体 参数 示例 说明
    HTTP Header X-GUGUDATA-APPKEY X-GUGUDATA-APPKEY: YOUR_APPKEY 推荐方式,适合服务端接入和统一封装。
    HTTP Header X-API-Key X-API-Key: YOUR_APPKEY 通用 API Key Header,便于和常见 API 客户端集成。
    HTTP Header Authorization Authorization: Bearer YOUR_APPKEY 适合 OpenAI 兼容接口或 Bearer Token 风格客户端。
    Query 参数 appkey ?appkey=YOUR_APPKEY 兼容现有示例、Postman 集合、浏览器调试和历史代码。

    部分历史 POST 接口仍兼容表单或 JSON body 中的 appkey;新接入建议优先使用 Header 或 Query 参数。

  • 接口常见 HTTP 响应状态码

    以下为接口调用中常见的 HTTP 传输层状态码,不等同于响应体内的业务状态码;完整状态码注册表以 IANA HTTP Status Code Registry 为准。

    状态码 状态码解释 备注
    200 请求成功 HTTP 请求已成功处理;业务状态请结合响应体中的自定义业务码判断。
    201 资源已创建 创建类接口请求成功,并已生成对应资源。
    202 请求已接受 请求已被接受处理,结果可能异步完成。
    204 无响应内容 请求成功但响应体为空,适用于无需返回数据的操作。
    400 请求参数错误 请求参数缺失、格式错误或参数组合不合法。
    401 认证失败 缺少、无效或未通过认证的访问凭证(如 AppKey)。
    403 无权限访问 订单到期、权限不足或接口额度不可用。
    404 资源不存在 请求路径不存在。
    405 请求方法不允许 当前路径不支持该 HTTP 方法。
    408 请求超时 客户端请求在服务端等待时间内未完成,可稍后重试。
    409 请求冲突 请求与当前资源状态冲突,调整参数或业务状态后重试。
    413 请求内容过大 上传文件或请求体超过接口限制。
    414 请求地址过长 请求 URL 超过服务端可处理长度,建议减少查询参数或改用 POST。
    415 请求内容类型不支持 上传或请求体的内容类型不符合接口要求。
    422 请求语义错误 请求格式正确,但参数取值、语义或业务约束无法处理。
    429 请求频率受限 默认按来源 IP 限速,单 IP 最多 5 QPS,可满足常规业务调用。超出限制时接口会返回 429 请求频率受限;已购买接口订单可加购 10 QPS 扩展。
    431 请求头过大 请求头字段过大或过多,建议精简 Header 后重试。
    500 服务器内部错误 服务端处理异常,请稍后重试。
    502 服务暂时不可用 请稍后重试。
    503 服务暂时不可用 请稍后重试。
    504 请求超时 请稍后重试。
  • 接口自定义业务状态码

    业务状态码 业务状态码解释 备注
    100 请求成功 HTTP 200
    501 参数错误 HTTP 400
    504 APPKEY 缺失或无效 HTTP 401
    901 正文抽取依赖失败或超时 HTTP 503
  • 请求示例代码

    curl --location --request POST 'https://api.gugudata.com/websitetools/readability?appkey=YOUR_APPKEY' \
    --header 'Content-Type: application/x-www-form-urlencoded' \
    --data-urlencode 'url=https://cdn.gugudata.com/demo/fetchcontentimages/v1/article-e65ee1f448ca5233.html'
    #include <curl/curl.h>
    
    int main(void) {
      CURL *curl = curl_easy_init();
      if (curl) {
        curl_easy_setopt(curl, CURLOPT_URL, "https://api.gugudata.com/websitetools/readability?appkey=YOUR_APPKEY");
        curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "POST");
        curl_easy_setopt(curl, CURLOPT_FOLLOWLOCATION, 1L);
        struct curl_slist *headers = NULL;
        headers = curl_slist_append(headers, "Content-Type: application/x-www-form-urlencoded");
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
        curl_easy_setopt(curl, CURLOPT_POSTFIELDS, "url=https%3a%2f%2fcdn.gugudata.com%2fdemo%2ffetchcontentimages%2fv1%2farticle-e65ee1f448ca5233.html");
        CURLcode res = curl_easy_perform(curl);
        (void)res;
        curl_slist_free_all(headers);
        curl_easy_cleanup(curl);
      }
      return 0;
    }
    
    using System;
    using System.Collections.Generic;
    using System.IO;
    using System.Net.Http;
    
    var client = new HttpClient();
    var request = new HttpRequestMessage(HttpMethod.Post, "https://api.gugudata.com/websitetools/readability?appkey=YOUR_APPKEY");
    request.Content = new FormUrlEncodedContent(new Dictionary<string, string>
    {
        { "url", "https://cdn.gugudata.com/demo/fetchcontentimages/v1/article-e65ee1f448ca5233.html" }
    });
    var response = client.SendAsync(request).Result;
    Console.WriteLine(response.Content.ReadAsStringAsync().Result);
    
    package main
    
    import (
      "strings"
      "fmt"
      "io"
      "net/http"
    )
    
    func main() {
      url := "https://api.gugudata.com/websitetools/readability?appkey=YOUR_APPKEY"
      payload := strings.NewReader("url=https%3a%2f%2fcdn.gugudata.com%2fdemo%2ffetchcontentimages%2fv1%2farticle-e65ee1f448ca5233.html")
      req, err := http.NewRequest("POST", url, payload)
      if err != nil {
        fmt.Println(err)
        return
      }
      req.Header.Add("Content-Type", "application/x-www-form-urlencoded")
      res, err := http.DefaultClient.Do(req)
      if err != nil {
        fmt.Println(err)
        return
      }
      defer res.Body.Close()
      body, err := io.ReadAll(res.Body)
      if err != nil {
        fmt.Println(err)
        return
      }
      fmt.Println(string(body))
    }
    
    OkHttpClient client = new OkHttpClient().newBuilder().build();
    MediaType mediaType = MediaType.parse("application/x-www-form-urlencoded");
    RequestBody body = RequestBody.create(mediaType, "url=https%3a%2f%2fcdn.gugudata.com%2fdemo%2ffetchcontentimages%2fv1%2farticle-e65ee1f448ca5233.html");
    Request request = new Request.Builder()
      .url("https://api.gugudata.com/websitetools/readability?appkey=YOUR_APPKEY")
      .method("POST", body)
      .build();
    Response response = client.newCall(request).execute();
    System.out.println(response.body().string());
    
    $.ajax({
      url: "https://api.gugudata.com/websitetools/readability?appkey=YOUR_APPKEY",
      method: "POST",
      data: { "url": "https://cdn.gugudata.com/demo/fetchcontentimages/v1/article-e65ee1f448ca5233.html" },
    }).done(function (response) {
      console.log(response);
    });
    
    const https = require("node:https");
    const url = "https://api.gugudata.com/websitetools/readability?appkey=YOUR_APPKEY";
    const { URLSearchParams } = require("node:url");
    const body = new URLSearchParams({ "url": "https://cdn.gugudata.com/demo/fetchcontentimages/v1/article-e65ee1f448ca5233.html" }).toString();
    
    const request = https.request(url, {
      method: "POST",
      headers: {
        "Content-Type": "application/x-www-form-urlencoded",
        "Content-Length": Buffer.byteLength(body)
      }
    }, handleResponse);
    request.on("error", console.error);
    request.write(body);
    request.end();
    
    function handleResponse(response) {
      const chunks = [];
      response.on("data", function (chunk) {
        chunks.push(chunk);
      });
      response.on("end", function () {
        console.log(Buffer.concat(chunks).toString("utf8"));
      });
    }
    
    #import <Foundation/Foundation.h>
    
    NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"https://api.gugudata.com/websitetools/readability?appkey=YOUR_APPKEY"]];
    [request setHTTPMethod:@"POST"];
    NSString *body = @"url=https%3a%2f%2fcdn.gugudata.com%2fdemo%2ffetchcontentimages%2fv1%2farticle-e65ee1f448ca5233.html";
    [request setValue:@"application/x-www-form-urlencoded" forHTTPHeaderField:@"Content-Type"];
    [request setHTTPBody:[body dataUsingEncoding:NSUTF8StringEncoding]];
    NSURLSessionDataTask *task = [[NSURLSession sharedSession] dataTaskWithRequest:request completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
      if (error) {
        NSLog(@"%@", error);
        return;
      }
      NSLog(@"%@", [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding]);
    }];
    [task resume];
    
    <?php
    $curl = curl_init();
    curl_setopt_array($curl, array(
      CURLOPT_URL => "https://api.gugudata.com/websitetools/readability?appkey=YOUR_APPKEY",
      CURLOPT_RETURNTRANSFER => true,
      CURLOPT_FOLLOWLOCATION => true,
      CURLOPT_CUSTOMREQUEST => "POST",
      CURLOPT_POSTFIELDS => "url=https%3a%2f%2fcdn.gugudata.com%2fdemo%2ffetchcontentimages%2fv1%2farticle-e65ee1f448ca5233.html",
      CURLOPT_HTTPHEADER => array(
        "Content-Type: application/x-www-form-urlencoded",
      ),
    ));
    $response = curl_exec($curl);
    curl_close($curl);
    echo $response;
    
    import requests
    
    url = "https://api.gugudata.com/websitetools/readability?appkey=YOUR_APPKEY"
    payload = { "url": "https://cdn.gugudata.com/demo/fetchcontentimages/v1/article-e65ee1f448ca5233.html" }
    response = requests.post(url, data=payload)
    print(response.text)
    
    require "uri"
    require "net/http"
    
    url = URI("https://api.gugudata.com/websitetools/readability?appkey=YOUR_APPKEY")
    https = Net::HTTP.new(url.host, url.port)
    https.use_ssl = true
    request = Net::HTTP::Post.new(url)
    request["Content-Type"] = "application/x-www-form-urlencoded"
    request.body = "url=https%3a%2f%2fcdn.gugudata.com%2fdemo%2ffetchcontentimages%2fv1%2farticle-e65ee1f448ca5233.html"
    response = https.request(request)
    puts response.read_body
    
    import Foundation
    
    let semaphore = DispatchSemaphore(value: 0)
    var request = URLRequest(url: URL(string: "https://api.gugudata.com/websitetools/readability?appkey=YOUR_APPKEY")!, timeoutInterval: .infinity)
    request.httpMethod = "POST"
    request.addValue("application/x-www-form-urlencoded", forHTTPHeaderField: "Content-Type")
    request.httpBody = "url=https%3a%2f%2fcdn.gugudata.com%2fdemo%2ffetchcontentimages%2fv1%2farticle-e65ee1f448ca5233.html".data(using: .utf8)
    let task = URLSession.shared.dataTask(with: request) { data, response, error in
      defer { semaphore.signal() }
      guard let data = data else {
        print(String(describing: error))
        return
      }
      print(String(data: data, encoding: .utf8)!)
    }
    task.resume()
    semaphore.wait()
    
  • 常见问题 Q&A

    • Q: 如何完成第一次 API 调用?

      A: 先确认当前接口的请求方法、必填参数和成功状态,再使用对应产品的 AppKey 发起请求;以实际响应中的业务状态判断结果。 查看接入指南

    • Q: 如何保证请求时 AppKey 的安全性?

      A: 在开发者中心的 APP KEY 管理页面复制对应产品的 AppKey,并保存在服务端环境变量或密钥管理服务中。不要写入网页、App 客户端、公开仓库或日志。

    • Q: 接口可以用于哪些开发语言?

      A: Java、Python、Node.js、PHP、Go、C#、Swift、Kotlin 等支持 HTTP 请求的语言均可接入;也可以通过 OpenAPI、Postman 或 Apifox 查看和调试接口。

    • Q: 请求失败或超时后可以重试吗?

      A: 先区分 HTTP 状态与业务错误。参数、鉴权和权限错误应修正后再请求;超时并不表示服务端未执行,重试前需确认接口是否会重复计费或产生副作用。 查看接入指南

    • Q: 接口的性能可以保证吗?

      A: 实际响应时间受接口类型、参数和网络环境影响。请按当前套餐的 QPS 控制并发,生产接入前完成联调与容量评估。

  • 服务协议与免责声明

    购买或使用 GuGuData API 服务前,请充分阅读服务协议、免责声明与数据合规声明。相关页面均支持在浏览器中快速导出 PDF,便于内部归档、评审和合规留存。

  • 技术支持

    技术支持邮箱:
    support@gugudata.com
    企业微信客服:
    联系客服
  • 专业软件开发与系统工程服务

    GuGuData 官方认证工程合作伙伴,专注企业级数据接口集成、AI 工程化与大规模数据处理。团队深度理解 GuGuData 数据接口体系,具备海量数据采集、治理、检索与高并发接口服务经验,可围绕业务场景构建 AI Agent、MCP 接入、智能工作流和生产级数据应用,让数据能力稳定进入现有流程、内部平台和核心业务系统。

    了解工程服务