数据 API 端点列表

本接口用于获取数据 API 当前可用的端点列表，便于后续创建数据任务。

GET https://api.seermartech.cn/v3/keywords_data/endpoints

本接口无需请求体。请求时请使用以下认证方式：

Authorization: Bearer smt_live_YOUR_KEY

计费说明

调用本接口不收取费用。扣费以响应头 X-SeerMarTech-Charge-CNY 为准。

请求示例

cURL

curl --request GET \
  --url https://api.seermartech.cn/v3/keywords_data/endpoints \
  --header 'Authorization: Bearer smt_live_YOUR_KEY'

PHP

<?php

require('RestClient.php');

$apiUrl = 'https://api.seermartech.cn/';

try {
    $client = new RestClient($apiUrl, [
        'Authorization' => 'Bearer smt_live_YOUR_KEY'
    ]);

    // 获取数据 API 的可用端点列表
    // GET /v3/keywords_data/endpoints
    $result = $client->get('/v3/keywords_data/endpoints');

    print_r($result);
} catch (RestClientException $e) {
    echo "\n";
    print "HTTP 状态码: {$e->getHttpCode()}\n";
    print "错误码: {$e->getCode()}\n";
    print "错误信息: {$e->getMessage()}\n";
    print $e->getTraceAsString();
    echo "\n";
}

Python

from client import RestClient

# 使用平台 API 密钥进行认证
client = RestClient("Bearer smt_live_YOUR_KEY")

# 获取数据 API 的可用端点列表
# GET /v3/keywords_data/endpoints
response = client.get("/v3/keywords_data/endpoints")

if response == 20000:
    print(response)
    # 在此处理返回结果
else:
    print("请求失败。错误码: %s，错误信息: %s" % (response, response))

C#

using Newtonsoft.Json;
using System;
using System.Net.Http;
using System.Net.Http.Headers;
using System.Threading.Tasks;

namespace SeerMarTechDemos
{
    public static partial class Demos
    {
        public static async Task KeywordsDataEndpoints()
        {
            var httpClient = new HttpClient
            {
                BaseAddress = new Uri("https://api.seermartech.cn/"),
                DefaultRequestHeaders =
                {
                    Authorization = new AuthenticationHeaderValue(
                        "Bearer",
                        "smt_live_YOUR_KEY"
                    )
                }
            };

            // 获取数据 API 的可用端点列表
            // GET /v3/keywords_data/endpoints
            var response = await httpClient.GetAsync(
                "/v3/keywords_data/endpoints"
            );

            var result = JsonConvert.DeserializeObject<dynamic>(
                await response.Content.ReadAsStringAsync()
            );

            if (result.status_code == 20000)
            {
                // 在此处理返回结果
                Console.WriteLine(result);
            }
            else
            {
                Console.WriteLine(
                    $"请求失败。错误码: {result.status_code}，" +
                    $"错误信息: {result.status_message}"
                );
            }
        }
    }
}

响应说明

接口返回 JSON 对象 tasks 数组本次请求的任务信息，result 数组可用于创建数据任务的端点列表。

顶层响应字段

字段	类型	说明
version	string	当前 API 版本
status_code	integer	通用响应状态码
status_message	string	通用响应说明
time	string	请求执行耗时，单位为秒
cost	float	平台原始 USD 成本兼容字段；人民币实扣以 X-SeerMarTech-Charge-CNY 为准。
tasks_count	integer	tasks 数组中的任务数量
tasks_error	integer	tasks 数组中返回错误的任务数量
tasks	array	任务对象数组

任务字段

字段	类型	说明
id	string	平台分的任务唯一标识，采用 UUID 格式
post_id	string	请求方自定义的任务标识
status_code	integer	当前任务的状态码，通常在 10000 至 60000 范围
status_message	string	当前任务的状态说明
time	string	任务执行耗时，单位为秒
cost	float	平台原始 USD 成本兼容字段；人民币实扣以 X-SeerMarTech-Charge-CNY 为准。
result_count	integer	result 数组中的数量
path	array	请求使用的 URL 路径
data	array/object	本次 API 调用提交的数据
result	array	当前任务的结果数组，可用的数据 API 端点

响应示例

{
  "version": "0.1.20210917",
  "status_code": 20000,
  "status_message": "Ok.",
  "time": "0.0736 sec.",
  "cost": 0,
  "tasks_count": 1,
  "tasks_error": 0,
  "tasks": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "post_id": null,
      "status_code": 20000,
      "status_message": "Ok.",
      "time": "0.0000 sec.",
      "cost": 0,
      "result_count": 1,
      "path": [
        "v3",
        "keywords_data",
        "endpoints"
      ],
      "data": {
        "api": "keywords_data",
        "function": "endpoints"
      },
      "result": [
        {
          "path": "/v3/keywords_data/..."
        }
      ]
    }
  ]
}

result 中的取决于当前开放的数据产品和端点。建议在创建任务前调用本接口，动态获取可用路径，在客户端硬编码已下线或变更的端点。

状态码

• 20000：请求成功。
• 状态码：请求或任务处理失败，原因请结合 status_code 和 status_message 判断。

完整错误码信息请参考错误码文档。

实用场景

• 发现可用端点：在系统初始化或版本升级时获取当前数据接口列表，降低端点变更导致的调用失败。
• 生成任务：根据返回的端点路径动态生成任务创建表单或项，加快 SEO 数据产品接。
• 校验接口能力：在提交查询、搜索量或趋势分析任务前确认目标端点是否可用，减少无效请求。
• 构建自动化调度器：定期读取端点列表并更新任务路由，为批量分析系统提供动态能力。
• 维护多产品集成：统一管理不同数据模块的 API 路径，便于 SEO 平台扩展新的数据来源和分析功能。