API 概述与鉴权
开发者 API 提供了一套遵循 RESTful 风格的 HTTP 接口,用于通过编程方式管理账户统计、计费数据及关键词监控任务。
基础信息
所有 API 请求必须基于 HTTPS 协议,数据交互格式为 JSON。
- Base URL:
https://kuaipai.ai - 数据返回格式:所有接口均返回 JSON(截图二进制流接口除外),包含
success布尔值字段指示请求状态。
鉴权方式(Authentication)
API 采用 API Key 机制进行永久身份鉴权。每次请求需将您的密钥置于 HTTP 请求头的 Authorization 字段中,并使用 Bearer 前缀。
获取密钥与安全性
API Key 作为您的唯一凭证,具备永久有效性(除非您在控制台中主动撤销)。前往控制台的「账号设置」页面,在「API 密钥」区域生成专属密钥。请务必妥善保管,切勿在前端代码或公共仓库中泄露,否则可能导致账户资金被滥用。若收到 401 Unauthorized,请检查密钥是否正确或是否已被禁用。
接口契约与调试说明
为了帮助您更快地完成系统集成,我们的开发者文档提供了标准化的接口参考规范:
- 标准化接口契约与在线联调沙盒
每个 API 详情页均提供完整的 Path/Query/Body 参数类型定义、必填约束说明以及右侧多语言代码生成面板(内置
cURL、Python、Node.js、Go、Rust示例)。支持一键复制代码或直接导入 Postman、Apifox 快速联调。 - 统一状态码与幂等设计
所有业务响应均遵循统一的
{ "success": true, ... }顶层结构,配合标准 HTTP 状态码(如400参数校验失败、401鉴权失败、429频控拦截),便于在各类语言环境(cURL、Python、Node.js、Go、Rust 等)中封装通用 HTTP 客户端。
Header 格式规范
1Authorization: Bearer ts_live_YOUR_API_KEY