跳转到主要内容
工作空间（Workspace）是 DocFlow 中用于组织和隔离文档处理任务的基本单位。每个工作空间可以包含文件类别、审核规则库等资源，便于进行多租户或多项目管理。
本文介绍如何使用工作空间相关接口：创建、查看、更新与删除。

​
创建工作空间

创建一个新的工作空间： 
curl -X POST \
  -H "x-ti-app-id: <your-app-id>" \
  -H "x-ti-secret-code: <your-secret-code>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "我的工作空间",
    "description": "这是一个用于处理发票的工作空间",
    "enterprise_id": 12345,
    "auth_scope": 1
  }' \
  "https://docflow.textin.com/api/app-api/sip/platform/v2/workspace/create"
请求参数：
  • name (必填): 工作空间名称，最大长度 50
  • description (选填): 工作空间描述，最大长度 200
  • enterprise_id (必填): 企业组织 ID
  • auth_scope (必填): 协作范围，0: 仅自己可见, 1: 企业成员可见
响应示例： 
{
  "code": 200,
  "msg": "success",
  "result": {
    "workspace_id": "1234567890"
  }
}

​
获取工作空间列表

获取当前用户的所有工作空间列表： 
curl \
  -H "x-ti-app-id: <your-app-id>" \
  -H "x-ti-secret-code: <your-secret-code>" \
  "https://docflow.textin.com/api/app-api/sip/platform/v2/workspace/list?enterprise_id=12345&page=1&page_size=20"
请求参数：
  • enterprise_id (必填): 企业 ID
  • page (选填): 页码，默认为 1
  • page_size (选填): 每页数量，默认为 20
响应示例： 
{
  "code": 200,
  "msg": "success",
  "result": {
    "total": 10,
    "page": 1,
    "page_size": 20,
    "workspaces": [
      {
        "workspace_id": "1234567890",
        "name": "我的工作空间",
        "description": "这是一个用于处理发票的工作空间",
        "auth_scope": 1,
        "manage_account_id": "admin_123456",
        "manage_account_name": "张三",
        "callback_url": "https://example.com/callback",
        "callback_retry_time": 3
      }
    ]
  }
}

​
获取工作空间详情

根据空间 ID 获取工作空间详细信息： 
curl \
  -H "x-ti-app-id: <your-app-id>" \
  -H "x-ti-secret-code: <your-secret-code>" \
  "https://docflow.textin.com/api/app-api/sip/platform/v2/workspace/get?workspace_id=1234567890"
请求参数：
  • workspace_id (必填): 工作空间 ID

​
更新工作空间

更新指定工作空间的信息： 
curl -X POST \
  -H "x-ti-app-id: <your-app-id>" \
  -H "x-ti-secret-code: <your-secret-code>" \
  -H "Content-Type: application/json" \
  -d '{
    "workspace_id": "1234567890",
    "name": "更新后的工作空间名称",
    "description": "更新后的描述",
    "auth_scope": 1,
    "callback_url": "https://example.com/callback",
    "callback_retry_time": 3
  }' \
  "https://docflow.textin.com/api/app-api/sip/platform/v2/workspace/update"
请求参数：
  • workspace_id (必填): 工作空间 ID
  • name (必填): 工作空间名称，最大长度 50
  • description (选填): 工作空间描述，最大长度 200
  • auth_scope (必填): 协作范围，0: 仅自己可见, 1: 企业成员可见
  • callback_url (选填): 回调 URL
  • callback_retry_time (选填): 回调重试次数，范围 0-3

​
删除工作空间

删除指定的工作空间（可以批量删除）： 
curl -X POST \
  -H "x-ti-app-id: <your-app-id>" \
  -H "x-ti-secret-code: <your-secret-code>" \
  -H "Content-Type: application/json" \
  -d '{
    "workspace_ids": ["1234567890", "0987654321"]
  }' \
  "https://docflow.textin.com/api/app-api/sip/platform/v2/workspace/delete"
请求参数：
  • workspace_ids (必填): 要删除的工作空间 ID 数组
删除工作空间会同时删除其下的所有资源（包括文件类别、审核规则库等），请谨慎操作。

​
下一步