开发者

API文档

将Chat Saku的功能集成到您的系统中的API参考和部署指南。

集成方式

脚本标签嵌入

只需在HTML中添加一行代码即可部署聊天机器人,最简单的方式。

<script
  src="https://widget.chat-saku.app/widget.js"
  data-api-key="YOUR_API_KEY"
  data-merchant-id="YOUR_MERCHANT_ID"
  async>
</script>

REST API

可从外部系统调用聊天功能,适用于LINE集成或自定义前端。

curl -X POST https://api.chat-saku.app/api/v1/chat \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "営業時間を教えてください",
    "conversation_id": "optional-id"
  }'

WordPress 插件

通过WordPress后台即可安装和配置,无需编辑代码。

// WordPress管理画面から
// 1. プラグイン → 新規追加
// 2. "Chat Saku" を検索
// 3. インストール → 有効化
// 4. 設定画面でAPIキーを入力

认证方式

API Key 认证

用于小部件或服务端调用聊天API。可在仪表盘的设置页面获取API密钥。

X-API-Key: sk_live_xxxxxxxxxxxx

Firebase Auth

用于访问仪表盘和商户管理API。将Firebase Auth令牌设置在Authorization请求头中。

Authorization: Bearer eyJhbGci...

主要端点

方法端点说明认证
POST/api/v1/chat发送聊天消息并获取AI回复。API Key
GET/api/v1/conversations获取对话历史列表。Firebase Auth
GET/api/v1/conversations/:id获取特定对话的详情和消息。Firebase Auth
GET/api/v1/knowledge获取知识库项目列表。Firebase Auth
POST/api/v1/knowledge创建新的知识项目。Firebase Auth
GET/api/v1/analytics/overview获取聊天机器人的分析数据。Firebase Auth

速率限制

根据方案适用月对话数上限。API调用限制为每秒10个请求。

Webhook

实时接收新对话和线索信息。企业版方案可用。

安全

所有通信采用TLS 1.3加密。API密钥以SHA-256哈希方式存储。

获取API密钥,开始使用吧

即使是免费的Starter方案也支持API访问。立即注册获取API密钥。

免费注册