Appearance
数据转发
数据转发功能支持两种方式:PostData(通过webhook发送到外部系统)和MongoDB存储。
PostData配置
获取PostData配置
获取当前组织的PostData配置信息。
请求
http
GET /api/v2/post-data/响应
json
{
"success": true,
"data": {
"url": "https://example.com/webhook",
"secret_key": "your-secret-key",
"enabled": true
},
"error": null
}保存PostData配置
创建或更新PostData配置。
请求
http
POST /api/v2/post-data/save/请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| url | string | 是 | webhook接收数据的URL |
| secret_key | string | 否 | 用于签名验证的密钥 |
| enabled | boolean | 否 | 是否启用,默认false |
请求示例
json
{
"url": "https://example.com/webhook",
"secret_key": "your-secret-key",
"enabled": true
}响应
json
{
"success": true,
"data": {
"url": "https://example.com/webhook",
"secret_key": "your-secret-key",
"enabled": true
},
"error": null
}重置密钥
重置PostData的secret key。
请求
http
POST /api/v2/post-data/reset-secret-key/响应
json
{
"success": true,
"data": {
"url": "https://example.com/webhook",
"secret_key": "new-generated-secret-key",
"enabled": true
},
"error": null
}测试连接
测试PostData配置是否可用。
请求
http
POST /api/v2/post-data/test/请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| url | string | 否 | 要测试的URL,不填则使用已保存的配置 |
| secret_key | string | 否 | 要测试的密钥,不填则使用已保存的配置 |
请求示例
json
{
"url": "https://example.com/webhook",
"secret_key": "test-secret-key"
}响应
json
{
"success": true
}MongoDB配置
获取MongoDB配置
获取当前组织的MongoDB配置信息。
请求
http
GET /api/v2/save-to-mongodb/响应
json
{
"success": true,
"data": {
"uri": "mongodb://username:password@host:port/database",
"collection": "data_collection",
"enabled": true
},
"error": null
}保存MongoDB配置
创建或更新MongoDB配置。
请求
http
POST /api/v2/save-to-mongodb/save/请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| uri | string | 是 | MongoDB连接URI |
| collection | string | 是 | 数据存储的集合名称 |
| enabled | boolean | 否 | 是否启用,默认false |
请求示例
json
{
"uri": "mongodb://username:password@host:port/database",
"collection": "data_collection",
"enabled": true
}响应
json
{
"success": true,
"data": {
"uri": "mongodb://username:password@host:port/database",
"collection": "data_collection",
"enabled": true
},
"error": null
}测试连接
测试MongoDB配置是否可用。
请求
http
POST /api/v2/save-to-mongodb/test/请求参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| uri | string | 否 | 要测试的MongoDB URI,不填则使用已保存的配置 |
| collection | string | 否 | 要测试的集合名称,不填则使用已保存的配置 |
请求示例
json
{
"uri": "mongodb://username:password@host:port/database",
"collection": "test_collection"
}响应
json
{
"success": true
}错误码
| 错误码 | 说明 | 错误信息 |
|---|---|---|
| 400 | 请求参数错误 | 具体的参数错误信息 |
| 400 | PostData URL未设置 | "请输入 PostData URL" |
| 400 | MongoDB URI未设置 | "请输入 MongoDB URI" |
| 400 | 连接测试失败 | "测试失败: {具体错误信息}" |
| 401 | 未认证 | "认证失败" |
| 403 | 无权限访问 | "无权限执行此操作" |
响应格式
错误响应的格式如下:
json
{
"success": false,
"data": null,
"error": {
"code": 400,
"message": "错误信息"
}
}