主题
Keywords Data 可用端点列表
GET /v3/keywords_data/endpoints
接口说明
该接口用于获取 Keywords Data API 当前可用的任务提交端点列表,便于在程序中动态发现和校验可调用能力。
- 请求方式:
GET - 请求地址:
https://api.seermartech.cn/v3/keywords_data/endpoints - 计费:****
- 参考价:约 ¥0.0000 / 次
- 实扣费以响应头
X-SeerMarTech-Charge-CNY为准
该接口返回 JSON 数据,响应中 tasks 数组;每个任务对象中会携带本次请求的执行信息以及可用于设置 Keywords Data API 任务的端点列表。
请求信息
HTTP Request
GET /v3/keywords_data/endpoints
请求头示例
http
Authorization: Bearer smt_live_YOUR_KEY该接口为 GET 请求,无需请求体。
响应结构
顶层字段
| 字段名 | 类型 | 说明 |
|---|---|---|
version | string | API 当前版本 |
status_code | integer | 通用状态码 |
status_message | string | 通用状态信息 |
time | string | 执行耗时,单位:秒 |
cost | float | 本次请求总成本,单位:USD |
tasks_count | integer | tasks 数组中的任务数量 |
tasks_error | integer | tasks 数组中返回错误的任务数量 |
tasks | array | 任务数组 |
tasks[] 字段
| 字段名 | 类型 | 说明 |
|---|---|---|
id | string | 任务唯一标识,UUID 格式 |
post_id | string | 你在系统中定义的自定义任务标识;如未提供,也可能由系统分 |
status_code | integer | 任务状态码,范围通常为 10000-60000 |
status_message | string | 任务状态说明 |
time | string | 任务执行耗时,单位:秒 |
cost | float | 当前任务成本,单位:USD |
result_count | integer | result 数组中的数量 |
path | array | URL 路径 |
data | array / object | 本次 API 调用中提交的数据 |
result | array | 结果数组,当前可用于设置 Keywords Data API 任务的端点列表 |
完整错误码与状态信息请参考:
/v3/appendix/errors
响应示例
json
{
"version": "0.1.20210917",
"status_code": 20000,
"status_message": "Ok.",
"time": "0.0736 sec.",
"cost": 0,
"tasks_count": 1,
"tasks_error": 0,
"tasks": [
{
"data": {
"api": "keywords_data",
"function": "endpoints"
},
"result": []
}
]
}说明:示例存在格式缺失,这里按标准 JSON 结构整理展示。返回的
result中会该分类下可用的端点列表。
状态码说明
| 状态码 | 说明 |
|---|---|
20000 | 请求成功 |
10000-60000 | 任务级状态码范围,表示不同处理结果或错误 |
更多错误码请参考:/v3/appendix/errors
代码示例
cURL
bash
curl -X GET "https://api.seermartech.cn/v3/keywords_data/endpoints" \
-H "Authorization: Bearer smt_live_YOUR_KEY"Python
python
import requests
url = "https://api.seermartech.cn/v3/keywords_data/endpoints"
headers = {
"Authorization": "Bearer smt_live_YOUR_KEY"
}
# 获取 Keywords Data 可用端点列表
resp = requests.get(url, headers=headers)
data = resp.json
# 判断接口是否调用成功
if data.get("status_code") == 20000:
print(data)
else:
print(f'error. Code: {data.get("status_code")} Message: {data.get("status_message")}')TypeScript
typescript
const url = "https://api.seermartech.cn/v3/keywords_data/endpoints";
async function getKeywordsDataEndpoints {
const response = await fetch(url, {
method: "GET",
headers: {
"Authorization": "Bearer smt_live_YOUR_KEY"
}
});
const result = await response.json;
// 判断接口返回状态
if (result.status_code === 20000) {
console.log(result);
} else {
console.error(`error. Code: ${result.status_code} Message: ${result.status_message}`);
}
}
getKeywordsDataEndpoints;使用建议
在以下场景中,建议优调用本接口:
- 在服务启动时拉取一次可用端点列表,用于动态任务路由。
- 在多环境或多版本容场景中,确认当前账号可调用的 Keywords Data 端点,再创建任务请求。
- 在开发调试阶段,用于快速检查某一数据能力是否已开放或路径是否正确。
实用场景
- 发现可用能力:自动读取 Keywords Data 下可调用的端点,手工维护接口单,降低接出错率。
- 校验接口容性:在应用启动或发布前检查当前环境支持的端点,提前发现版本差异或能力缺失。
- 动态生成任务路由:根据返回的端点列表自动决定后续请求应提交到哪个
/v3/...路径,提升系统灵活性。 - 构建开发:为控制台或调试展示可用的数据接口,帮助运营和开发快速定位能力。
- 监控接口变更:定期拉取端点列表并比对历史结果,及时发现平台 API 新增、调整或下线的能力。