AllYend Developer Docs

开发者文档

涵盖接入所需的 Python SDK、HTTP API 概览与调用示例。所有接口基于 /api/v1 统一前缀与 API Key 鉴权。

SDK 下载

提供轻量级 Python 客户端 SDK,支持单文件引入或完整 ZIP 压缩包下载。

快速开始(Python)

使用 with 上下文管理器自动维护连接,涵盖注册爬虫、心跳、日志与运行生命周期。

from sdk.crawler_client import CrawlerClient

BASE = "https://pscly.cc"  # 后端地址
API_KEY = "<你的APIKey>"

with CrawlerClient(BASE, API_KEY, retries=2, backoff_factor=0.3) as client:
    crawler = client.register_crawler("news_spider")
    run = client.start_run(crawler_id=crawler["id"])  # 记录一次运行
    client.log(crawler_id=crawler["id"], level="INFO", message="启动")
    client.heartbeat(crawler_id=crawler["id"], payload={"tasks_completed": 12})

    # 轮询远程指令(可在独立线程中运行)
    # client.run_command_loop(crawler_id=crawler["id"], interval_seconds=5.0)

    client.finish_run(crawler_id=crawler["id"], run_id=run["id"], status="success")

HTTP API 概览

所有路径均挂载于 /api/v1 下,并在请求头携带 X-API-Key。

方法端点路径说明
POST/register注册爬虫实例
POST/{crawlerId}/heartbeat上报心跳与自定义指标 payload
POST/{crawlerId}/runs/start启动一次运行记录
POST/{crawlerId}/runs/{runId}/finish结束运行并回报状态
POST/{crawlerId}/commands/next拉取待执行远程指令
POST/{crawlerId}/commands/{commandId}/ack回执远程指令执行结果
POST/{crawlerId}/logs上报爬虫运行日志

示例(cURL)

BASE="https://pscly.cc/api/v1"
API_KEY="<你的APIKey>"

curl -sS -X POST "$BASE/register" \
  -H "X-API-Key: $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"news_spider"}'