接口参考
检查店铺能否监控 API
POST
/v1/monitor/check-monitor-site免费·api.etshop.ai/open-apiCredits 消耗规则
计费规则:店铺/商品列表与热销榜每返回 1 条扣 1 Credit,店铺详情每次扣 2 Credits;详情、趋势、每日数据、评论免费(需 3 天内在列表或详情中返回过)。关键词搜索每个词扣 1 Keyword Credit,30 天内同一个词免费。店铺监控每个店铺扣 1 Monitor Credit,监控 30 天,停止后不退还。空结果不扣费,服务器错误自动退还。
请求头
AUTHORIZATION
Authorization: {API Key}CONTENT-TYPE
application/jsonACCEPT
application/json请求示例
cURL
curl --location --request POST 'https://api.etshop.ai/open-api/v1/monitor/check-monitor-site' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: {API Key}' \
--data-raw '{
"urls": [
"https://www.etsy.com/shop/PrintPalaceStudio",
"NordicCanvasCo",
"https://www.etsy.com/shop/OldVintageFinds"
]
}' 请求参数
按参数标注的位置传入请求。
| 参数 | 类型 | 说明 |
|---|---|---|
| body
body · 必填
| object | 请求体(JSON) |
| » urls
body · 必填
| [string] | 店铺名称或店铺链接,例如 PrintPalaceStudio 或 https://www.etsy.com/shop/PrintPalaceStudio;最多 50 个 |
返回示例
返回示例 · JSON
{
"code": 200,
"message": "success",
"data": {
"total": 3,
"added_count": 1,
"removed_count": 2,
"details": [
{
"url": "https://www.etsy.com/shop/PrintPalaceStudio",
"code": 200,
"message": "success"
},
{
"url": "NordicCanvasCo",
"code": 409,
"message": "Your store has already been added, no need to submit again."
},
{
"url": "https://www.etsy.com/shop/OldVintageFinds",
"code": 400,
"message": "Store closed"
}
]
},
"credits": {
"type": "monitor_credits",
"remaining_credits": 98,
"consumed_credits": 0,
"total_credits": 100
}
}
文档中的示例数据
返回数据结构
| 名称 | 类型 | 必选 | 约束 | 说明 |
|---|---|---|---|---|
| » code | integer | true | none | 业务状态码 |
| » message | string | true | none | 响应消息 |
| » data | object | true | none | 响应数据 |
| »» total | integer | true | none | 提交的店铺总数 |
| »» added_count | integer | true | none | 可以监控的店铺数量 |
| »» removed_count | integer | true | none | 不能监控的店铺数量 |
| »» details | [object] | true | none | 每个店铺的检查结果 |
| »»» url | string | true | none | 提交的店铺名称或链接 |
| »»» code | integer | true | none | 检查结果:200 可以监控;409 该店铺已在监控中;400 其它原因不能监控(链接无法解析、店铺已关闭、店铺暂时无法访问等),原因见 message |
| »»» message | string | true | none | 检查结果说明 |
| » credits | object | true | none | 本次请求的 Credits 信息,见计费规则 |
| »» type | string | true | none | Credits 类型,本接口为 monitor_credits |
| »» remaining_credits | integer | true | none | 本次请求后剩余的 Monitor Credits |
| »» consumed_credits | integer | true | none | 本次请求消耗的 Monitor Credits,本接口为 0 |
| »» total_credits | integer | true | none | Monitor Credits 总数量 |
