Skip to content

API 参考: 应用 (Apps)

应用管理端点。创建、更新、删除和发布应用。

创建应用

上传应用定义。如果 app.id 已存在,自动执行更新。

POST /v1/apps

权限要求: write

请求体

字段类型必填说明
appobject应用基本信息
app.idstring应用唯一标识符
app.namestring英文名称
app.nameZhstring中文名称
app.domainstring所属领域
app.subsystemstring子系统类型
serviceConfigobject服务配置(凭据、URL等)
dashboardobject仪表盘组件定义
toolPacksstring[]关联的工具包 ID 列表

请求示例

bash
curl -X POST https://api.invoratec.cn/v1/apps \
  -H "X-API-Key: claw_xxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "app": {
      "id": "my-erp",
      "name": "My ERP Connector",
      "nameZh": "我的ERP连接器",
      "domain": "operations",
      "subsystem": "ERP"
    },
    "serviceConfig": {
      "credentials": ["username", "password"]
    },
    "dashboard": {},
    "toolPacks": ["erp-inventory-pack"]
  }'

响应 (201 Created)

json
{
  "_id": "665f1a2b3c4d5e6f7a8b9c0d",
  "appId": "my-erp",
  "developerId": "user_123",
  "definition": {
    "app": { "id": "my-erp", "name": "My ERP Connector", ... },
    "serviceConfig": { ... },
    "dashboard": { ... },
    "toolPacks": ["erp-inventory-pack"]
  },
  "status": "draft",
  "createdAt": "2026-04-12T08:00:00.000Z",
  "updatedAt": "2026-04-12T08:00:00.000Z"
}

如果应用已存在(更新),响应中额外包含 "updated": true

错误

状态码说明
400app.idapp.name 缺失
401API Key 无效
403缺少 write 权限

列出我的应用

GET /v1/apps

请求示例

bash
curl https://api.invoratec.cn/v1/apps \
  -H "X-API-Key: claw_xxxx"

响应

json
{
  "apps": [
    {
      "_id": "665f...",
      "appId": "my-erp",
      "definition": { ... },
      "status": "draft",
      "updatedAt": "2026-04-12T08:00:00.000Z"
    }
  ],
  "total": 1
}

获取应用详情

GET /v1/apps/{id}

路径参数

参数类型说明
idstring应用 appId

请求示例

bash
curl https://api.invoratec.cn/v1/apps/my-erp \
  -H "X-API-Key: claw_xxxx"

响应

返回完整的应用文档,包含 definition 中的所有字段。

错误

状态码说明
404应用不存在

更新应用

PUT /v1/apps/{id}

权限要求: write

路径参数

参数类型说明
idstring应用 appId

请求体

可以更新 appserviceConfigdashboardtoolPacks 中的任意字段,也可以更新 status

请求示例

bash
curl -X PUT https://api.invoratec.cn/v1/apps/my-erp \
  -H "X-API-Key: claw_xxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "app": {
      "id": "my-erp",
      "name": "My ERP Connector v2"
    }
  }'

响应

返回更新后的完整应用文档。

错误

状态码说明
403缺少 write 权限
404应用不存在

删除应用

DELETE /v1/apps/{id}

权限要求: write

路径参数

参数类型说明
idstring应用 appId

请求示例

bash
curl -X DELETE https://api.invoratec.cn/v1/apps/my-erp \
  -H "X-API-Key: claw_xxxx"

响应

json
{ "success": true }

发布应用到市场

将应用状态从 draft 变为 published,使其在应用市场中可见。

POST /v1/apps/{id}/publish

权限要求: write

路径参数

参数类型说明
idstring应用 appId

请求示例

bash
curl -X POST https://api.invoratec.cn/v1/apps/my-erp/publish \
  -H "X-API-Key: claw_xxxx"

响应

json
{
  "success": true,
  "status": "published"
}

错误

状态码说明
403缺少 write 权限
404应用不存在

智航云 AI 中台 — 开发者平台