API 与集成

接口调用快速上手

API 与集成·更新于 2026-05·约 3 分钟

拿到 API 令牌后,就能用任何能发 HTTP 请求的工具调用 veilx 接口。下面用最少的步骤跑通第一个请求。

认证方式

调用接口时,在请求头里带上你的令牌完成认证,例如:

  • Authorization 头中携带令牌。
  • 所有请求走 HTTPS,确保凭证在传输中加密。

发起第一个请求

以读取站点列表为例,用 curl 发一个 GET 请求:

curl -H "Authorization: Bearer <your-token>" \
  https://api.veilx.io/v1/sites

返回会是一段 JSON,列出你账户下的站点。把令牌换成你自己的,即可看到真实数据。

读懂返回与错误

  • 2xx 表示成功,响应体是请求的数据。
  • 401 / 403 通常是令牌无效或权限不足,检查令牌与其范围。
  • 429 表示调用过于频繁,适当降低请求速率或加重试退避。
  • 4xx 的响应体一般带有错误说明,按提示修正请求参数。