创建应用与开发测试
Sandbox 用于应用开发和联调。在当前部署环境的开发者后台,使用本人账号创建应用。首次没有企业时自动准备个人空间,应用创建者自动成为所有者。
保存配置后,平台会自动检查应用、OAuth 身份、API 调用权限和 Webhook,通过后立即启用,无需人工审核。失败时按页面提示修正并重试。找回历史无负责人的应用需通过人工支持处理。
一个独立产品使用一个应用,可以启用应用身份、用户身份或两者。两种身份分别配置 OAuth Client 和 API 权限。应用 Owner 可按凭证页当前状态查看或轮换应用身份 Secret;用户身份使用 PKCE,无需 Client Secret。
仅接登录时,创建应用、填写实际回调并复制配置、验证登录即可,见应用接入流程。API、事件和商业按需配置,未选能力不是登录前置。登录后由平台解析用户与客户空间,无需填写固定企业 ID;需目标环境完成合同启用。
Sandbox 是应用环境,与 GoodVision 的部署环境不同。配置成功不替代企业成员关系、用户同意(Consent)、资源 ACL、付款资格或 Webhook 端点安全校验。重复提交不会重复创建,未完成配置的资源不会显示为
active。
按需准备配置
创建应用只需填写名称,其他配置在使用对应功能时补充。不要在普通表单中填写 Secret、Token、私钥或客户数据。
| 字段 | 示例 | 要求 |
|---|---|---|
| 应用名称 | Acme Workflow Connector | 便于识别产品和用途 |
| Application Code | 自动生成 | 可选;需要自定义时展开高级设置,仅小写字母、数字和连字符 |
| 运行范围 | 测试(sandbox) | 创建时默认为测试范围;正式上线使用独立资源 |
| 应用身份权限 | 需要 / 不需要 | 用于服务端任务和后端调用 |
| 用户身份权限 | 需要 / 不需要 | 用于用户登录后的操作;需要精确 Callback URL |
| API Product | 控制台中的已发布产品 | 使用业务 API 时选择 |
| Scope | 最小权限集合 | 使用业务 API 时按应用和环境配置并自动校验 |
| Webhook Endpoint | https://sandbox.example.com/goodvision/events | 仅选择 HTTPS 接收或同步回调时需要;长连接无需公网地址 |
| 事件类型 | oem.subscription.expired.v1 | 接收事件时只选实际消费的类型 |
| 联系人 | 技术、安全、Support | 用于故障、轮换和弃用通知 |
创建应用并测试
- 打开当前部署环境的开发者后台,使用本人账号登录。
- 核对企业或个人空间。首次初始化暂不可用时重试;已选企业无权时不静默切换。
- 填写名称创建 Sandbox 应用,平台自动生成代码并授予创建者应用所有权,保存返回的 Application ID。
- 如需业务 API,按调用代表应用还是用户配置所需权限。
- 如需事件,优先选择长连接并运行服务端示例;选择 HTTPS 或同步回调时再校验接收地址。
- 应用身份显示
self_service/ “可自助获取”时,通过“凭证与基础信息”即时获取 Client Secret;如果显示“等待安全交付”,则等待批准渠道。查看或轮换均要求专用权限。用户身份明确无需 Secret。 - 实际完成联调后,在“Sandbox 与上线”阅读当前适用测试并一次确认,可附最多 10 个非敏感证据引用。配置变化后需重新测试并确认。
- 准备正式配置,在“版本管理与发布”创建版本并提交上线审核。测试确认与正式配置准备可分别进行;审核通过后仍需显式发布,批准不会自动上线。
没有创建权限时,通过“本企业团队”联系企业负责人;没有 API Product 时核对当前环境目录。依赖故障按页面重试,不使用他人账号,也不先申请与接入无关的业务权限。
请在开发者后台配置调用身份与 API 权限,平台会自动创建和更新对应 Client。接入无需调用平台管理接口或动态注册入口。
准备测试企业和人员
“应用管理 → 测试环境与人员”用于限制 Sandbox 用户访问。名单默认关闭,保持原访问规则;启用后仅允许名单中的当前有效成员。名单不授予 OAuth Scope、用户同意或产品权益,也不改变 Production 和应用身份原有授权。
- 选择当前可访问的企业;需要独立测试时,填写名称“创建企业用于测试”,代码自动生成。
- 先保存当前名单草稿,再点击“准备所选企业成员”。明确确认企业切换,在“本企业团队”邀请真人账号并由本人接受。
- 返回原应用,重新读取有效成员;启用限制后选择 1~100 人并保存。“操作原因”可留空,自动记录配置说明。
- 配置用户身份、精确回调和所需 Scope,由测试人员本人登录实际应用并调用,验证允许、移出名单后的拒绝及故障恢复。
创建的是持久企业,不是临时虚拟租户。邀请只建立企业成员关系,不自动授予应用协作者或商业权益。保存名单不表示完成登录或 API 测试。无法返回原企业时,不恢复旧应用或权限。
不能创建企业时,可以继续使用已有企业,并刷新可访问企业列表。创建被拒绝只清理新建表单,已选测试成员和未保存配置会保留;测试配置仍按当前应用权限独立校验。若应用测试管理权限已被撤销,页面会清理名单并停止相关操作。登录过期时,按页面提示重新登录并核验当前权限,再明确提交需要的操作。
确认适用测试
| 测试 | 需要验证的结果 |
|---|---|
| 身份与 Token 处理 | 未授权或过期身份不能继续使用 |
| 已使用的写操作 | 原请求恢复不重复执行业务 |
| 已配置的事件 | 重复、乱序、延迟和断线后状态正确 |
| 已使用的服务凭据 | 轮换后可连接且不记录敏感值 |
| 预期使用场景 | 测试人员在实际应用中完成所选接入流程 |
页面只要求当前适用项,一次确认记录你的测试完成声明。自动配置校验不替代应用测试;仅登录时,未使用的 API、事件或服务凭据不是前置。结果未知恢复原确认;冲突先重读配置;确定的输入错误修正后重新确认。Production 仍需独立资源和验收。
获取接入配置
| 交付物 | 用途 |
|---|---|
| Application ID | 标识应用,用于 API 请求和问题诊断 |
| OAuth Client ID | 标识当前应用和环境 |
| 应用身份 Client Secret 或证书 | 仅当启用应用身份时提供,只用于已批准流程 |
| API 产品调用配置 | 提供 Base URL、Audience、Scope、Schema、配额和支持范围 |
| Webhook Secret | 验证该 Webhook Subscription 的 HMAC 签名 |
支持工单不会返回 Secret。应用身份具备相应权限时可在凭证页临时查看;无法确认暴露范围时应立即轮换,轮换后旧 Secret 立即失效。
常见状态
| 状态 | 含义 | 下一步 |
|---|---|---|
configuration_required | 配置尚未完成 | 按当前页面提示补齐配置 |
active | 自动配置成功,已启用 | 使用当前应用的调用配置开始联调 |
self_service | OAuth Client 已签发,可按页面提示自助获取 Secret | 在凭证页临时查看或轮换 |
pending_delivery | OAuth Client 已签发,服务凭据尚未确认交付 | 等待批准的安全渠道,不要在工单中索取原值 |
pending | 尚未确认适用测试 | 实际测试后确认;不要求人工审核 |
sandbox_ready | 当前配置的适用测试已确认 | 核对正式配置,创建上线版本 |
suspended / paused | 暂停使用 | 查询原因并按支持流程恢复 |
revoked | 已撤销,终态 | 需要继续开发时创建新应用,不复用旧凭证 |