1. 00|接入指南
yousure-api
  • 00|接入指南
    • 数字员工接入指南
      GET
  • 01|项目密钥
    • 创建项目 API 密钥
      POST
    • 查询项目 API 密钥
      GET
    • 轮换项目 API 密钥
      POST
    • 吊销项目 API 密钥
      POST
  • 02|凭据保险库
    • 保存企业系统调用凭据
      POST
    • 查询凭据元数据列表
      GET
    • 查看凭据元数据
      GET
    • 轮换企业系统调用凭据
      POST
    • 吊销企业系统调用凭据
      POST
  • 03|企业系统集成
    • 从接口描述导入企业系统
      POST
    • 创建企业系统集成
      POST
    • 查询企业系统集成列表
      GET
    • 查看企业系统集成
      GET
    • 修改企业系统集成信息
      PATCH
    • 重新发现远程 MCP 工具
      POST
    • 检查远程 MCP 服务状态
      GET
    • 查看集成生成的工具
      GET
    • 测试企业系统工具
      POST
    • 发布集成和工具版本
      POST
    • 停用企业系统集成
      POST
  • 04|工具目录与执行
    • 查询可用工具目录
      GET
    • 查看工具定义
      GET
    • 查询工具执行记录
      GET
    • 查看工具执行详情
      GET
  • 05|技能设计
    • 创建技能草稿
    • 查询技能列表
    • 查看技能
    • 修改技能草稿
    • 发布技能版本
    • 查看技能历史版本
    • 比较两个技能版本
    • 回滚到历史技能版本
    • 归档技能
  • 06|工具集配置
    • 创建工具集草稿
    • 查询工具集列表
    • 查看工具集
    • 修改工具集草稿
    • 发布工具集版本
    • 查看工具集历史版本
    • 比较两个工具集版本
    • 回滚到历史工具集版本
    • 归档工具集
  • 07|权限策略
    • 创建权限策略草稿
    • 查询权限策略列表
    • 查看权限策略
    • 修改权限策略草稿
    • 发布权限策略版本
    • 查看权限策略历史版本
    • 比较两个权限策略版本
    • 回滚到历史权限策略版本
    • 归档权限策略
  • 08|数字员工
    • 创建数字员工草稿
    • 查询数字员工列表
    • 查看数字员工
    • 修改数字员工草稿
    • 发布数字员工版本
    • 查看数字员工历史版本
    • 比较两个数字员工版本
    • 回滚到历史数字员工版本
    • 归档数字员工
  • 09|快速创建
    • 提交数字员工快速创建任务
    • 查看快速创建结果
    • 查看后台任务状态
    • 查询后台任务事件
    • 实时订阅后台任务事件
  • 10|会话任务与事件
    • 创建数字员工会话
    • 查询数字员工会话列表
    • 查看数字员工会话
    • 提交数字员工任务
    • 查询会话任务列表
    • 查看任务执行状态
    • 补拉会话事件
    • 实时订阅会话事件
    • 追加任务指令
    • 中断正在执行的任务
    • 关闭数字员工会话
  • 11|审批中心
    • 查询待处理审批
    • 查看审批详情
    • 批准工具执行
    • 拒绝工具执行
    • 撤销审批决定
  • 12|用量与账单
    • 查询原始计费用量事件
    • 查询当前计费权益
    • 查看用量和金额汇总
    • 查询计费分录
    • 查询项目账单列表
    • 查看项目账单
  • 13|管理后台与组织
    • 登录管理后台
    • 查看当前登录会话
    • 查询可用租户和项目
    • 切换管理项目
    • 刷新管理后台令牌
    • 退出管理后台
    • 创建租户和首个项目
    • 查询租户列表
    • 停用租户
    • 创建企业项目
    • 查询企业项目列表
    • 停用企业项目
    • 添加项目成员
    • 查询项目成员列表
    • 调整成员角色和范围
    • 撤销成员授权
    • 停用管理后台用户
    • 查询审计事件
    • 导出审计事件 CSV
    • 查看平台运行状态
  • 14|平台计费管理
    • 创建计费套餐
    • 查询计费套餐和版本
    • 创建套餐计费版本
    • 启用套餐计费版本
    • 创建或切换项目订阅
    • 查询项目订阅
    • 添加人工计费调整
    • 冲正计费分录
    • 生成并封存项目账单
  • 15|高级原生接口
    • 创建原生线程
    • 启动原生任务回合
    • 补拉原生运行事件
    • 实时订阅原生运行事件
    • 追加原生回合输入
    • 中断原生任务回合
    • 响应原生服务端请求
    • 调用高级原生方法
  • 16|系统状态
    • 检查服务存活状态
    • 检查数据库和运行时就绪状态
  • 数据模型
    • OpenPlatformOnboardingGuide
    • BillingEntitlement
    • BillingSummary
    • BillingEntry
    • BillingEntryPage
    • BillingStatement
    • BillingStatementPage
    • BillingPlanVersion
    • BillingPlan
    • BillingSubscription
    • CreateBillingPlanRequest
    • CreateBillingPlanVersionRequest
    • CreateBillingSubscriptionRequest
    • CreateBillingAdjustmentRequest
    • ReverseBillingEntryRequest
    • FinalizeBillingStatementRequest
    • CredentialSecret
    • CreateCredentialRequest
    • RotateCredentialRequest
    • Credential
    • CredentialPage
    • IntegrationSource
    • ImportIntegrationRequest
    • PatchIntegrationRequest
    • IntegrationVersion
    • Integration
    • IntegrationPage
    • Approval
    • ApprovalPage
    • ApprovalDecisionRequest
    • RequiredApprovalDecisionRequest
    • McpConnection
    • McpHealth
    • McpDiscoveryResult
    • ToolManifest
    • IntegrationTool
    • Tool
    • ToolCollection
    • ToolPage
    • IntegrationImport
    • TestIntegrationRequest
    • IntegrationTestResult
    • PublishIntegrationRequest
    • IntegrationPublication
    • ToolExecution
    • ToolExecutionPage
    • ProductSession
    • ProductSessionResult
    • ProductSessionPage
    • CreateProductSessionRequest
    • ProductTextInputItem
    • ProductTurnInput
    • ProductTurn
    • ProductTurnResult
    • ProductTurnPage
    • ProductEvent
    • ProductEventPage
    • ResourceVersion
    • ResourceView
    • ResourcePage
    • CreateResourceRequest
    • PatchResourceRequest
    • RollbackRequest
    • VersionDiffEntry
    • VersionDiffPage
    • ResourceDefinition
    • EmployeeDefinition
    • SkillDefinition
    • ToolSetDefinition
    • PolicyDefinition
    • Readiness
    • PublicError
    • RpcCall
    • RpcResult
    • YousureEvent
    • EventPage
    • ServerRequestResponse
    • ThreadStarted
    • TurnStarted
    • UsageEvent
    • UsagePage
    • CreateApiKeyRequest
    • ApiKeyMetadata
    • IssuedApiKey
    • ApiKeyPage
    • QuickStartSource
    • QuickStartEmployee
    • QuickStartCreateRequest
    • QuickStartResource
    • QuickStart
    • Job
    • QuickStartAccepted
    • JobEvent
    • JobEventPage
    • ConsoleRole
    • ConsoleContext
    • ConsoleSession
    • ConsoleTokenResponse
    • Tenant
    • TenantPage
    • Project
    • ProjectPage
    • ConsoleUser
    • MembershipScope
    • CreateMembershipRequest
    • Membership
    • MembershipPage
    • AuditEvent
    • AuditEventPage
    • OperationsStatus
  1. 00|接入指南

数字员工接入指南

GET
/v1/open-platform/onboarding
本接口为Yousure Harness接入指南,请在接入前仔细阅读
推荐流程:申请企业项目 → 获取并安全保存 API Key → 选择 HTTP API 或 SDK →
接入 OpenAPI、Tool Manifest 或 Remote MCP 工具 → 创建并发布数字员工 →
创建 Session 和 Turn → 通过 SSE 获取结果 → 查询用量与账单。
重要事项:API Key 不得进入浏览器、移动端安装包、源码或日志;测试、预发、生产应使用不同项目;
Session 和 Turn 必须携带幂等键;HTTP 受理不代表任务完成,应等待 SSE 终态事件;高风险工具应启用审批和审计。

请求参数

无

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location '/v1/open-platform/onboarding'

返回响应

🟢200
application/json
第三方数字员工建设步骤、接入方式、流程图和重要注意事项。
Bodyapplication/json

示例
{
    "title": "第三方数字员工接入指南",
    "description": "取得项目 API Key 后,通过 HTTP API 或 SDK 接入企业工具、发布数字员工,并使用 Session、Turn 与 SSE 完成任务。",
    "apiBaseUrl": "https://harness.youshu.yun",
    "integrationOptions": [
        "HTTP API",
        "TypeScript/JavaScript SDK"
    ],
    "toolOptions": [
        "OpenAPI / Swagger",
        "Yousure Tool Manifest",
        "Remote MCP"
    ],
    "steps": [
        "申请企业租户和项目",
        "安全接收并保存项目 API Key",
        "选择 HTTP API 或 SDK",
        "导入、测试并发布企业工具",
        "创建 Skill、ToolSet、Policy 和 Employee",
        "发布数字员工版本",
        "创建 Session 并提交带幂等键的 Turn",
        "通过 SSE 接收终态并查询用量和账单"
    ],
    "flowchart": "flowchart LR\n    A[申请企业项目] --> B[安全接收 API Key]\n    B --> C{选择接入方式}\n    C -->|HTTP| D[按 OpenAPI 调用]\n    C -->|SDK| E[安装 Yousure SDK]\n    D --> F[接入业务工具]\n    E --> F\n    F --> G[创建技能 权限策略 工具集]\n    G --> H[创建并发布数字员工]\n    H --> I[创建 Session]\n    I --> J[提交 Turn]\n    J --> K[通过 SSE 接收事件]\n    K --> L{需要审批}\n    L -->|是| M[人工批准或拒绝]\n    L -->|否| N[取得执行结果]\n    M --> N\n    N --> O[查询用量与账单]",
    "importantNotes": [
        "API Key 只保存在服务端或密钥管理系统,不得放入网页和 App 包。",
        "测试、预发和生产环境必须使用不同项目和不同 API Key。",
        "创建 Session 和 Turn 时必须使用唯一且可复用的 Idempotency-Key。",
        "HTTP 201 仅表示 Turn 已受理,必须等待明确的终态事件。",
        "写入、付款、删除和外发类工具应启用服务端权限、审批和审计。"
    ]
}
修改于 2026-09-28 02:47:08
下一页
创建项目 API 密钥
Built with