客临门 API - 开发者文档

RESTful API v1

接口概览

所有接口基于 HTTPS，数据格式为 JSON。

项目	说明
Base URL	`https://api.kelinmen.com/api/v1`
协议	HTTPS (TLS 1.2+)
数据格式	JSON (Content-Type: application/json)
认证方式	Bearer Token (Header: Authorization)
频率限制	1000 次/分钟/IP

认证方式

通过登录获取 Token，后续请求在 Header 中携带。

POST /auth/login

请求体

{
  "email": "user@example.com",
  "password": "your_password"
}

响应

{
  "code": 0,
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIs...",
    "expires_in": 86400,
    "user": {
      "id": "U001",
      "name": "张明",
      "email": "user@example.com",
      "role": "admin"
    }
  }
}

提示 Token 有效期 24 小时，过期后请重新登录获取。所有需认证的接口在 Header 中携带：
Authorization: Bearer <your_token>

线索管理

获取线索列表

GET /leads?page=1&size=20&status=pending_review

参数	类型	必填	说明
`page`	int	否	页码，默认 1
`size`	int	否	每页条数，默认 20，最大 100
`status`	string	否	状态筛选：pending_review / approved / assigned / outreach / replied
`grade`	string	否	等级筛选：A / B / C / D
`platform`	string	否	来源平台：douyin / xiaohongshu / kuaishou / website / offline

审核线索

PUT /leads/{id}/review

{
  "action": "approve",
  "comment": "高意向客户，优先跟进"
}

批量审核

POST /leads/batch-review

{
  "ids": ["L001", "L002", "L003"],
  "action": "approve"
}

渠道管理

获取渠道列表

GET /channels

接入新渠道

POST /channels

{
  "platform": "douyin",
  "name": "抖音企业号-北京",
  "config": {
    "app_id": "your_app_id",
    "app_secret": "your_app_secret"
  }
}

暂停/恢复渠道

PUT /channels/{id}/status

{ "status": "paused" }

会员中心

获取会员信息

GET /members/me

查询订单

GET /members/me/orders?page=1&size=10

订阅套餐

POST /members/subscribe

{
  "plan_id": "pro_yearly",
  "payment_method": "alipay"
}

错误码

Code	说明	处理建议
`0`	成功	-
`1001`	参数错误	检查请求参数
`2001`	未认证	检查 Token 是否有效
`2002`	Token 过期	重新登录获取 Token
`2003`	权限不足	联系管理员提升权限
`3001`	资源不存在	检查 ID 是否正确
`4001`	频率限制	降低请求频率
`5001`	服务器错误	联系技术支持

注意遇到错误时，响应体中会包含 message 字段描述具体错误原因。

CORS 跨域

API 支持跨域请求，允许以下域名访问：

Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, PUT, DELETE, OPTIONS
Access-Control-Allow-Headers: Content-Type, Authorization

客临门 API 文档