• API 功能

    • 支持生肖、精确公历生日或兼容出生年份输入;
    • 公历生日按农历春节边界计算生肖;
    • 返回可核对的周期起止范围;
    • 固定输出事业、沟通与生活内容;
    • 支持同步、任务和 SSE 响应;
    • 结果仅供文化研究与娱乐参考;
    • 全接口通过 HTTPS 提供服务;
    • 全面兼容 Apple ATS;
    • 全国多节点 CDN 部署;
    • 默认最大 QPS:5,可在开发者中心自助升级,月付年付订单接口调用次数不限;
    • 接口调用状态与状态监控
  • API 文档

    接口地址: https://api.gugudata.com/ai/chinese-zodiac-period-insight

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

    请求方式: POST

    请求协议: HTTPS

    请求示例: https://api.gugudata.com/ai/chinese-zodiac-period-insight?appkey=YOUR_APPKEY

    数据预览: https://www.gugudata.com/preview/chinese-zodiac-period-insight

    接口测试:  https://api.gugudata.com/ai/chinese-zodiac-period-insight/demo

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

    请求参数(POST 请求参数以 application/json 格式传递;鉴权方式请参见下方示例代码)

    参数名 参数类型 是否必须 默认值 备注
    appkey string YOUR_APPKEY 支持 Query、X-GUGUDATA-APPKEY、Bearer 或 JSON body。
    zodiac string 生肖名称;与 birthDate、birthYear 必须且只能传一个。
    birthDate string N/A 公历出生日期,按农历春节换年精确计算生肖。
    birthYear integer N/A 兼容字段,按公历年份简化映射;春节前后建议改传 birthDate。
    period string today 支持 today、tomorrow、week、month、year。
    targetDate string N/A 周期计算基准日期,不传时使用北京时间当天。
    language string zh-CN 支持 zh-CN、zh-TW、en-US。
    responseMode string sync 支持 sync 或 task。
    streaming boolean false SSE 仅支持同步模式。

    返回参数

    参数名 参数类型 备注
    DataStatus.StatusCode integer 业务码,100 表示成功。
    DataStatus.StatusDescription string 业务状态说明。
    Data.基础数据.生肖 string 规范化生肖。
    Data.基础数据.周期 string 本次内容周期。
    Data.基础数据.周期标识 string 兼容周期标识。
    Data.基础数据.输入信息 object 输入方式、规范化输入值和输出语言。
    Data.基础数据.生肖计算 object 计算方式、换年规则和兼容性说明。
    Data.基础数据.目标日期 string 周期计算基准日期。
    Data.基础数据.周期范围 object 北京时间下的开始日期和结束日期。
    Data.文化解读 object 固定结构的生肖周期文化内容。
    Data.免责声明 string 文化研究与娱乐参考边界。
    Data.operationId string 任务模式的任务标识。
    Data.status string 任务状态。
    Data.pollingUrl string 任务状态查询地址。
    Data.result object 任务成功时的完整结果。
    Data.error object 任务失败信息。
    SSE.done.result object 流式完成事件的完整已校验结果。
  • 鉴权方式

    接口支持以下 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 无响应内容 请求成功但响应体为空,适用于无需返回数据的操作。
    304 资源未变更 配合缓存或条件请求使用,表示可继续使用本地缓存。
    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
    502 请求频率受限 HTTP 429
    503 订单已到期 HTTP 403
    504 APPKEY 错误 HTTP 401,包含缺少 APPKEY
    505 调用额度耗尽 HTTP 403
    900 内部错误 HTTP 500
    901 依赖服务不可用 HTTP 503,不缓存无效结果
  • 请求示例代码

    curl --location --request POST 'https://api.gugudata.com/ai/chinese-zodiac-period-insight?appkey=YOUR_APPKEY' \
    --header 'Content-Type: application/x-www-form-urlencoded' \
    --data-urlencode 'zodiac=龙' \
    --data-urlencode 'birthDate=N/A' \
    --data-urlencode 'birthYear=N/A' \
    --data-urlencode 'period=today' \
    --data-urlencode 'targetDate=N/A' \
    --data-urlencode 'language=zh-CN' \
    --data-urlencode 'responseMode=sync' \
    --data-urlencode 'streaming=false'
    #include <curl/curl.h>
    
    int main(void) {
      CURL *curl = curl_easy_init();
      if (curl) {
        curl_easy_setopt(curl, CURLOPT_URL, "https://api.gugudata.com/ai/chinese-zodiac-period-insight?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, "zodiac=%e9%be%99&birthDate=N%2fA&birthYear=N%2fA&period=today&targetDate=N%2fA&language=zh-CN&responseMode=sync&streaming=false");
        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/ai/chinese-zodiac-period-insight?appkey=YOUR_APPKEY");
    request.Content = new FormUrlEncodedContent(new Dictionary<string, string>
    {
        { "zodiac", "龙" },
        { "birthDate", "N/A" },
        { "birthYear", "N/A" },
        { "period", "today" },
        { "targetDate", "N/A" },
        { "language", "zh-CN" },
        { "responseMode", "sync" },
        { "streaming", "false" }
    });
    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/ai/chinese-zodiac-period-insight?appkey=YOUR_APPKEY"
      payload := strings.NewReader("zodiac=%e9%be%99&birthDate=N%2fA&birthYear=N%2fA&period=today&targetDate=N%2fA&language=zh-CN&responseMode=sync&streaming=false")
      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, "zodiac=%e9%be%99&birthDate=N%2fA&birthYear=N%2fA&period=today&targetDate=N%2fA&language=zh-CN&responseMode=sync&streaming=false");
    Request request = new Request.Builder()
      .url("https://api.gugudata.com/ai/chinese-zodiac-period-insight?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/ai/chinese-zodiac-period-insight?appkey=YOUR_APPKEY",
      method: "POST",
      data: { "zodiac": "龙", "birthDate": "N/A", "birthYear": "N/A", "period": "today", "targetDate": "N/A", "language": "zh-CN", "responseMode": "sync", "streaming": "false" },
    }).done(function (response) {
      console.log(response);
    });
    
    const https = require("node:https");
    const url = "https://api.gugudata.com/ai/chinese-zodiac-period-insight?appkey=YOUR_APPKEY";
    const { URLSearchParams } = require("node:url");
    const body = new URLSearchParams({ "zodiac": "龙", "birthDate": "N/A", "birthYear": "N/A", "period": "today", "targetDate": "N/A", "language": "zh-CN", "responseMode": "sync", "streaming": "false" }).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/ai/chinese-zodiac-period-insight?appkey=YOUR_APPKEY"]];
    [request setHTTPMethod:@"POST"];
    NSString *body = @"zodiac=%e9%be%99&birthDate=N%2fA&birthYear=N%2fA&period=today&targetDate=N%2fA&language=zh-CN&responseMode=sync&streaming=false";
    [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/ai/chinese-zodiac-period-insight?appkey=YOUR_APPKEY",
      CURLOPT_RETURNTRANSFER => true,
      CURLOPT_FOLLOWLOCATION => true,
      CURLOPT_CUSTOMREQUEST => "POST",
      CURLOPT_POSTFIELDS => "zodiac=%e9%be%99&birthDate=N%2fA&birthYear=N%2fA&period=today&targetDate=N%2fA&language=zh-CN&responseMode=sync&streaming=false",
      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/ai/chinese-zodiac-period-insight?appkey=YOUR_APPKEY"
    payload = { "zodiac": "龙", "birthDate": "N/A", "birthYear": "N/A", "period": "today", "targetDate": "N/A", "language": "zh-CN", "responseMode": "sync", "streaming": "false" }
    response = requests.post(url, data=payload)
    print(response.text)
    
    require "uri"
    require "net/http"
    
    url = URI("https://api.gugudata.com/ai/chinese-zodiac-period-insight?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 = "zodiac=%e9%be%99&birthDate=N%2fA&birthYear=N%2fA&period=today&targetDate=N%2fA&language=zh-CN&responseMode=sync&streaming=false"
    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/ai/chinese-zodiac-period-insight?appkey=YOUR_APPKEY")!, timeoutInterval: .infinity)
    request.httpMethod = "POST"
    request.addValue("application/x-www-form-urlencoded", forHTTPHeaderField: "Content-Type")
    request.httpBody = "zodiac=%e9%be%99&birthDate=N%2fA&birthYear=N%2fA&period=today&targetDate=N%2fA&language=zh-CN&responseMode=sync&streaming=false".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: 如何保证请求时 AppKey 的安全性?

      A: 建议将 AppKey 保存在服务端环境中,由后端统一调用 API,再向前端或业务系统返回必要结果。不要把 AppKey 写入网页、App 客户端或公开仓库;生产环境建议按系统或业务线拆分 AppKey,并保留调用日志,便于权限控制、审计与问题排查。

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

      A: 只要支持 HTTPS 请求的语言和框架均可接入,包括 Java、Python、Node.js、PHP、Go、C#、Swift、Kotlin 等。推荐由后端统一封装调用逻辑,集中处理鉴权、缓存、限流、重试和错误码映射,让 Web、App、AI Agent、内部系统和自动化任务复用同一套数据能力。

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

      A: GuGuData API 按生产环境标准部署,持续关注接口稳定性、响应速度与可用性。实际响应时间会受接口类型、请求参数、数据源更新和网络环境影响;建议生产接入前进行联调与压测,并设置合理的超时、重试、降级和告警策略。批量处理或高并发场景可提前评估 QPS、白名单和专属容量方案。

  • 服务协议与免责声明

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

  • 技术支持

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

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

    了解工程服务