用友 ERP U9C OpenApi 调试工具 V1.1.0 说明文档
用友 ERP U9C OpenApi 调试工具 V1.1.0 说明文档
一、工具概述
本工具是一款专为用友 U9C ERP 系统打造的 OpenAPI 接口调试客户端，用于快速验证、调用 U9C 的各类业务 API，支持身份认证、通用 SQL 查询、业务接口调试等核心功能，帮助开发 / 运维人员快速完成接口对接、数据验证与问题排查。
二、界面与核心功能说明
- 基础配置区（请求前置参数）
表格
配置项 说明 示例值
BaseURL U9C 服务的根地址，格式为http://[服务器IP]/u9c http://192.168.70.131/u9c
API 身份认证接口地址，用于获取 Token /webapi/OAuth2/AuthLogin
SelectEnt 企业 / 账套选择下拉框，对应 U9C 的多组织架构 虚拟机测试 > 虚拟机测试
ClientId 第三方应用的客户端 ID，由 U9C 系统配置分配 MES
ClientSecret 第三方应用的客户端密钥，与 ClientId 配对使用 7c9c76f1f1b943
EntCode 企业编码（账套编码），对应 U9C 的企业档案编码 101
OrgCode 组织编码，对应 U9C 的组织架构编码 10
ApiUrl 目标业务 API 的请求路径，调试时自动填充或手动输入 /webapi/CustQueryDataAccessSQL/Qu…
Token 身份认证成功后返回的访问令牌，用于后续接口鉴权 eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9…
BizAPI 业务接口分类 / 快捷选择，当前示例为通用查询SQL 通用查询SQL
搜索框 快速筛选 API 列表，当前共支持 87 个 U9C 标准接口 （空，用于输入关键词筛选）
请求按钮 点击后根据配置参数发送 API 请求，触发接口调用 - - 请求体输入区（左侧）
用于输入接口的请求参数，支持 JSON 格式。
示例中调用通用查询SQL接口，请求体为：
json
{
“SQL”: “select * from base_user”
}
该请求的作用是执行 SQL 语句，查询 U9C 系统的base_user（用户档案）表数据。 - 响应结果展示区（右侧）
接口调用成功后，返回标准化 JSON 格式的响应数据，核心字段说明如下：
表格
字段 说明 示例值
ResCode 响应状态码，0表示接口调用成功 0
Success 调用结果布尔值，true表示请求成功 true
ResMsg 响应消息，无错误时为null null
Data 业务数据主体，为嵌套结构 -
IsSuccessed 内部业务执行结果，true表示 SQL 执行成功 true
Data[] SQL 查询返回的结果集，单条用户数据包含以下字段：
- ID：用户 ID
- CreatedOn：创建时间
- CreatedBy：创建人
- ModifiedOn：修改时间
- ModifiedBy：修改人
- Password：加密后的用户密码
- Code：用户编码
- Name：用户名称（如Enterprise Administrator）
- IsAlive：用户状态（true为启用）
- Effective_IsEffective：生效状态（true为有效） （示例中为管理员用户数据）
三、核心功能流程
配置基础参数：填写BaseURL、ClientId、ClientSecret、EntCode、OrgCode，选择目标企业 / 组织。
获取 Token：点击请求按钮，调用AuthLogin接口完成身份认证，Token 自动填充到对应字段。
选择业务接口：通过BizAPI下拉框或搜索框，选择目标业务接口（如通用 SQL 查询、单据操作接口等）。
输入请求参数：在左侧输入区按接口规范填写 JSON 格式请求体。
执行接口调用：再次点击请求按钮，发送请求并查看右侧响应结果，验证接口返回数据是否符合预期。
四、关键注意事项
权限控制：
ClientId/ClientSecret需在 U9C 系统中提前配置第三方应用授权，未授权的应用无法获取 Token。
EntCode/OrgCode需与实际账套、组织编码一致，否则会返回组织不存在错误。
通用查询SQL接口需配置数据查询权限，仅支持对授权表的查询操作，禁止执行增删改 SQL 语句。
Token 有效期：U9C 的 Token 默认有有效期（通常为 2 小时），过期后需重新调用AuthLogin接口获取新 Token。
安全规范：
ClientSecret、Token 属于敏感信息，禁止在生产环境中明文传输或泄露。
通用 SQL 查询接口仅用于调试与数据验证，禁止在生产环境中直接通过该接口执行高危 SQL 操作。
错误排查：
若 Token 获取失败，优先检查BaseURL连通性、账号密码 / 密钥正确性、企业组织编码是否匹配。
若接口返回业务错误，可通过ResMsg字段查看具体错误信息，核对请求参数格式与权限配置。
五、适用场景
第三方系统（如 MES、WMS）与 U9C ERP 的接口对接调试。
快速验证 U9C 系统的业务数据（如用户档案、物料档案、订单数据）。
排查 API 接口调用异常，定位参数、权限或系统层面的问题。
开发阶段的接口原型验证，减少直接编码对接的调试成本。
六、功能扩展
EntInfo.json：支持扩展多账套配置，通过预设企业编码、组织编码、账套名称，实现一键切换不同账套环境，无需手动修改参数，适配多组织架构场景。
u9copenapi.json：内置 87 个标准业务接口，并支持自定义扩展接口配置，可新增 / 修改接口路径、参数模板，适配不同版本 U9C 的 API 更新需求。