x-api-key 请求头中发送的长期有效密钥。还有两种更窄的令牌类型用于特定场景:会话 JWT 用于从仪表板会话发起的云浏览器生命周期操作,数据令牌嵌入在 CDP 会话 URL 中用于 WebSocket 访问。了解哪种凭证用于何处可以防止认证错误并确保你的密钥安全。
获取 API 密钥
登录后打开 AdsCrawl 仪表板,从密钥部分复制你的 API 密钥。将其存储在环境变量或密钥管理器中,切勿在应用源码中硬编码。发送 API 密钥
在每个请求的x-api-key 请求头中传递你的 API 密钥。请求头名称为小写,值为完整密钥字符串。
会话 JWT(云浏览器生命周期)
云浏览器列表、创建、启动、开始和停止端点也接受Authorization: Bearer <SESSION_JWT> 请求头中的会话 JWT。这是一个登录会话令牌,代表已登录的仪表板用户,而非 API 密钥。
会话认证在一点上比 API 密钥认证更窄:它在启动请求上需要 apiKeyId。你必须提供属于同一账户的活动、未过期 API 密钥的 UUID。API 密钥认证会自动选择当前密钥。
对于从仪表板发起的请求,会话 cookie 也可以替代 Bearer 令牌使用。对于所有服务器端和自动化工作流,请使用 API 密钥认证。
数据令牌(CDP WebSocket 访问)
当你创建 CDP 会话时,201 响应包含一个已经嵌入了数据令牌的 cdpBaseUrl:
cdpBaseUrl 传递给 Playwright 的 connectOverCDP。此 URL 中的数据令牌同时授权 CDP 发现端点(GET /cdp/sessions/:id/json/version)和 CDP WebSocket(WSS /cdp/sessions/:id/devtools/browser/:browserId)。
对于实时浏览器控制,使用你的 API 密钥认证的 POST /cdp/live-token 获取短期有效的 controlToken。此一次性令牌在 30 秒后过期,并授权一次到 WSS /cdp/live/:sessionId 的 WebSocket 连接。
错误参考
各套餐的 API 密钥限制
你可以创建的 API 密钥数量取决于你的套餐。每个密钥都是独立的,可以分配给不同的服务器或服务。你可以在 仪表板 中查看和管理你的 API 密钥、积分余额和套餐。要创建新账户,请访问 app.adscrawl.net/register。