API 概述

Perfex CRM SaaS 模块包含 REST API，允许您以编程方式管理 SaaS 平台。适用于：

• 自定义注册页面 - 构建您自己的注册流程
• 第三方集成 - 与外部工具连接（Zapier、Integromat、自定义应用）
• 计费自动化 - 与外部计费系统同步
• 监控 - 构建自定义仪表板和监控工具
• 移动应用 - 创建移动管理界面

API 入门

步骤 1：启用 API

1. 前往 SaaS Management → SuperAdmin Settings
2. 点击 API Settings 选项卡
3. 将 API 切换为 ON
4. 生成 API 令牌

步骤 2：身份验证

所有 API 请求都需要通过请求头中的 Bearer 令牌进行身份验证：

Authorization: Bearer YOUR_API_TOKEN_HERE

步骤 3：基础 URL

您的 API 基础 URL 为：

https://yoursite.com/api/saas/

将 yoursite.com 替换为您的实际域名。

---

快速示例

这里是通过 API 创建租户的快速示例：

curl -X POST https://yoursite.com/api/saas/tenants \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "company_name": "Acme Corp",
    "email": "[email protected]",
    "first_name": "John",
    "last_name": "Doe",
    "plan_id": 1,
    "subdomain": "acme"
  }'

Response:

{
  "success": true,
  "tenant_id": 42,
  "domain": "acme.yoursite.com",
  "message": "Tenant created successfully"
}

---

API 功能

端点组	您可以做什么
Tenants	创建、读取、更新、删除租户
Plans	列出、创建、更新计划
Subscriptions	管理租户订阅
Usage	查询租户使用情况和配额

有关完整端点列表，请参阅 API Reference。

---

速率限制

API 实施速率限制以保护您的服务器：

• 每个 API 令牌 每分钟 100 个请求
• 每个响应都包含速率限制头

如果超出速率限制，您将收到 429 Too Many Requests 响应。

---

最佳实践

1. 保密 API 令牌 - 切勿在客户端代码或公共仓库中暴露
2. 使用 HTTPS - 始终通过 HTTPS 发送 API 请求
3. 妥善处理错误 - 检查响应状态码并适当处理错误
4. 尽可能缓存 - 不要重复查询相同数据；当数据不常变化时缓存响应

信息

需要自定义集成？ 如果 API 无法满足您的需求，请通过 support 与我们联系。我们根据客户反馈不断扩展 API。

API Reference