• API 功能

    • 智能提取网页可阅读内容;
    • 提供网页可阅读内容的 HTML 代码;
    • 支持传递网页 HTML 或网页 URL 参数;
    • 支持多种元素信息抽取,包括文章标题、作者、文字方向、语言、内容、内容(不包含 HTML 标签,按段落分割)、文章长度、文章摘要、网站名称、文章发布时间;
    • 秒级解析性能,支持高并发;
    • 全接口支持 HTTPS(TLS v1.0 / v1.1 / v1.2 / v1.3);
    • 全面兼容 Apple ATS;
    • 全国多节点 CDN 部署;
    • 接口极速响应,多台服务器构建 API 接口负载均衡。
    • 接口调用状态与状态监控
  • API 文档

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

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

    请求方式: POST

    请求协议: HTTPS

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

    数据预览: 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 YOUR_APPKEY 付费后获取的 APPKEY
    html string YOUR_VALUE 需要抽取的网页 HTML 内容,与参数 url 二选一
    url string YOUR_VALUE 需要抽取的网页 URL 地址,与参数 html 二选一。(我们不处理因源站反爬而不能正常请求网页内容进行后续处理的问题)

    返回参数

    参数名 参数类型 备注
    DataStatus.RequestParameter string 接口请求参数
    DataStatus.StatusCode integer 接口返回状态码
    DataStatus.StatusDescription string 接口返回状态说明
    DataStatus.ResponseDateTime string 接口数据返回时间
    DataStatus.DataTotalCount integer 此条件下的总数据量,一般用于分页计算
    Data.Title string 文章标题
    Data.Byline string 文章作者
    Data.Dir string 文章文字方向
    Data.Lang string 文章语言
    Data.Content string 文章内容
    Data.TextContent string 文章内容(不包含 HTML 标签,按段落分割)
    Data.Length integer 文章长度
    Data.Excerpt string 文章摘要
    Data.SiteName string 网站名称
    Data.PublishedTime array 文章发布时间
  • 接口 HTTP 响应标准状态码

    状态码 状态码解释 备注
    200 接口正常响应 请求成功,业务状态请结合响应体中的自定义业务码判断。
    400 请求参数错误 请求参数缺失、格式错误或参数组合不合法。
    401 鉴权失败 缺少 appkey 或 appkey 无效。
    403 无权限访问 订单到期、权限不足或接口额度不可用。
    404 资源不存在 请求路径不存在。
    405 请求方法不允许 当前路径不支持该 HTTP 方法。
    415 请求内容类型不支持 上传或请求体的内容类型不符合接口要求。
    429 请求频率受限 请求频率超过服务限制,请适当降低调用速率。
    500 服务内部错误 服务端处理异常,请稍后重试。
    502 上游依赖错误 上游依赖服务不可用或返回异常。
  • 接口自定义状态码

    自定义状态码 自定义状态码解释 备注
    200 正常返回
    400 参数错误
    429 请求频率受限 每秒请求不能超过 100 次
    403 账号欠费 请及时关注订单到期短信提醒
    402 APPKEY 错误 请检查传递的 APPKEY 是否为开发者中心获取到的值
    500 接口响应错误
  • 请求示例代码
    curl --location --request POST 'https://api.gugudata.com/websitetools/readability?appkey=YOUR_APPKEY' \
    --header 'Content-Type: application/x-www-form-urlencoded' \
    --data-urlencode 'html=YOUR_VALUE' \
    --data-urlencode 'url=YOUR_VALUE'
    #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, "html=YOUR_VALUE&url=YOUR_VALUE");
        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>
    {
        { "html", "YOUR_VALUE" },
        { "url", "YOUR_VALUE" }
    });
    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("html=YOUR_VALUE&url=YOUR_VALUE")
      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, "html=YOUR_VALUE&url=YOUR_VALUE");
    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: { "html": "YOUR_VALUE", "url": "YOUR_VALUE" },
    }).done(function (response) {
      console.log(response);
    });
    
    const response = await fetch("https://api.gugudata.com/websitetools/readability?appkey=YOUR_APPKEY", {
      method: "POST",
      headers: { "Content-Type": "application/x-www-form-urlencoded" },
      body: new URLSearchParams({ "html": "YOUR_VALUE", "url": "YOUR_VALUE" })
    });
    console.log(await response.text());
    
    const response = await fetch("https://api.gugudata.com/websitetools/readability?appkey=YOUR_APPKEY", {
      method: "POST",
      headers: { "Content-Type": "application/x-www-form-urlencoded" },
      body: new URLSearchParams({ "html": "YOUR_VALUE", "url": "YOUR_VALUE" })
    });
    console.log(await response.text());
    
    #import <Foundation/Foundation.h>
    
    NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"https://api.gugudata.com/websitetools/readability?appkey=YOUR_APPKEY"]];
    [request setHTTPMethod:@"POST"];
    NSString *body = @"html=YOUR_VALUE&url=YOUR_VALUE";
    [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 => "html=YOUR_VALUE&url=YOUR_VALUE",
      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 = { "html": "YOUR_VALUE", "url": "YOUR_VALUE" }
    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 = "html=YOUR_VALUE&url=YOUR_VALUE"
    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 = "html=YOUR_VALUE&url=YOUR_VALUE".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: 数据请求有缓存吗?

      A: 我们为所有数据请求提供实时响应。对于定期更新的数据,我们在其更新周期内实施缓存策略,以优化性能。

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

      A: 我们建议将对 API 的请求操作放置在您的应用程序后端。这样,前端请求只与您的后端服务交互,确保了更高的安全性和易于维护的架构。

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

      A: 我们的接口支持所有能进行网络请求的开发语言,便于在各类项目中快速整合数据。

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

      A: 我们的接口后台使用与商业级项目相同的架构,保证了稳定且高效的性能。您可以通过访问测试接口了解更多性能信息。

  • 服务协议以及服务免责声明

    用户应当充分阅读 服务协议 以及 服务免责声明 ,用户购买与使用咕咕数据 API 服务亦视为接受本协议。

  • 技术支持

    • 技术支持邮箱: support@gugudata.com
    • 微信客服: 客服链接

业务相关接口推荐

获取任意链接正文图片
  • 智能分析链接正文中的图片集合
  • 解析任意链接 / 支持图片大小筛选
  • 1199元/年限时折扣 399元/年
查看详情 被调用于 5 秒前
30% 折扣
获取公众号文章封面
  • 解析任意公共号文章链接
  • 解析任意文章 / 返回官方地址
  • 399元/年限时折扣 199元/年
查看详情 被调用于 6 秒前
50% 折扣
稳定提供服务 10 年 获取任意链接文章正文
  • 智能分析抓取链接中的正文部分
  • 智能分析正文 / 包含 HTML 标签
  • 1999元/年限时折扣 999元/年
查看详情 被调用于 9 秒前
50% 折扣
语义化获取站点 JSON 结构内容
  • 语义智能提取任意网页内容结构化 JSON 数据
  • AI 智能提取 / 结构化数据 / 网页解析
  • 3999元/年限时折扣 1999元/年
查看详情 被调用于 5 秒前
50% 折扣