------------------------------------------------------------
✅ 设置API
###
克隆仓库并运行此命令 npm install(安装npm包) 在文件夹中添加 .env 文件 以“node index.js”命令运行
------------------------------------------------------------
✅ 健康检查
检查封装服务是否正常运行
------------------------------------------------------------
GET https://localhost:3000/ 翻译为中文是:“获取(请求)https://localhost:3000/ 资源”。不过,在实际语境中,我们通常会简化为“访问 https://localhost:3000/”或“获取 https://localhost:3000/ 的内容”,以更符合中文表达习惯 内容类型:应用/JSON
示例回复:
{
"状态": "正常",
"service": "Success.ai 封装器",,
"base_url": "https://api.success.ai" 翻译成中文为:“基础网址”:“https://api.success.ai”
}
------------------------------------------------------------
🔹 获取活动(快捷端点)
直接获取活动列表(映射到 /v1/campaign/list)
------------------------------------------------------------
获取 http://localhost:3000/campaigns?limit=10(即:向 http://localhost:3000/campaigns 发送 GET 请求,查询参数为 limit=10) 内容类型:应用/JSON
示例回复:
{
"success": true, 翻译为中文是:“成功”:true,
"data": \[ { "id": "...", "name": "...", ... } \] 翻译成中文为:“数据”:\[ { “id”:“...”, “name”:“...”, ... } \]
}
------------------------------------------------------------
🔹 添加联系人(快捷方式终端)
向活动添加一个或多个联系人
------------------------------------------------------------
POST 请求发送至 http://localhost:3000/contact/add 内容类型:应用/JSON
{ "campaignId": "65a88f123bcd12",翻译为中文是:“活动ID”:“65a88f123bcd12”, "联系人": \[ {"email": "john@example.com", "firstName": "John", "lastName": "Doe"} 翻译为中文是:{"邮箱": "john@example.com", "名字": "John", "姓氏": "Doe"}, {"email": "mary@example.com", "firstName": "Mary"} 翻译成中文是:{"邮箱": "mary@example.com", "名字": "玛丽"} \] }
示例回复:
{
"success": true, (翻译为中文)“成功”:true,
"插入": 2
}
------------------------------------------------------------
🔹 通用代理(主要终端节点)
使用此方法调用任何Success.ai API接口
------------------------------------------------------------
POST 请求发送至 http://localhost:3000/proxy 内容类型:application/json
{ "方法": "GET", "path": "/v1/campaign/list",翻译成中文是:“路径”:“/v1/活动/列表”, "params": { "limit": 5 } 翻译成中文是:“参数”:{ “限制”:5 } }
示例回复:
{"success": true, "data": \[...\] } 翻译为中文是:{"成功": true, "数据": \[...\] }
------------------------------------------------------------
🔹 获取活动状态(通过/proxy)
使用特定API的通用代理的示例
------------------------------------------------------------
POST http://localhost:3000/proxy(中文可译为:“向 http://localhost:3000/proxy 发送 POST 请求”,但通常在技术语境中,我们直接保留原句,因为“POST”是HTTP方法,直接使用即可理解。) 内容类型:application/json
{ "方法": "GET", "path": "/v1/campaign/get/status" 翻译成中文是:“路径”:“/v1/活动/获取/状态”, "params": { "campaignId": "65a88f123bcd12" } 翻译成中文是:“参数”:{“活动ID”:“65a88f123bcd12”} }
示例回复:
{
"success": true, (翻译为)"成功": true,,
"状态": "运行中",,
"进度": 42
}
------------------------------------------------------------
🔹 创建新活动(通过/proxy)
示例:通过代理执行POST操作
------------------------------------------------------------
POST 请求发送至 http://localhost:3000/proxy 内容类型:application/json
{ "方法": "POST", "path": "/v1/campaign/create" 翻译成中文为:“路径”:“/v1/活动/创建”, "body": { “名称”:“新人工智能推广活动”, "fromEmail": "sales@success.ai" 翻译成中文为:“发件人邮箱”:“sales@success.ai”, 主题:“欢迎来到SuccessAI!”, "templateId": "模板_01" } }
示例回复:
{
"success": true, (翻译为)“成功”:true,
"campaignId": "abc123xyz" 翻译成中文是:“活动ID”:“abc123xyz”
}
------------------------------------------------------------
🔹 删除活动(通过/proxy)
示例展示DELETE方法的使用
------------------------------------------------------------
POST 请求发送至 http://localhost:3000/proxy 内容类型:应用/JSON
{ "method": "DELETE",翻译为中文是:“方法”:“删除”, "path": "/v1/campaign/delete",翻译成中文是:“路径”:“/v1/活动/删除”, "params": { "campaignId": "abc123xyz" } 翻译成中文为:“参数”:{“活动ID”:“abc123xyz”} }
示例回复:
{"success": 真, "deleted": 真}
------------------------------------------------------------
🧪 测试无效路由(用于调试)
展示了错误如何以JSON格式返回
------------------------------------------------------------
POST 请求发送到 http://localhost:3000/proxy 内容类型:应用/JSON
{ "方法": "GET",, "path": "/v1/无效/路由" }
