甄零开放平台
  1. 开发者指南
甄零开放平台
  • 开发者指南
    • 开发者指南(必读)
    • 集成示例(必读)
    • 错误码
    • 数据字典
    • 更新日志
  • 1.认证及授权
    • 1.1 获取 Token
      POST
    • 查询异步接口处理状态
      GET
  • 2.主数据
    • 2.1 相对方批量查询
      POST
    • 2.2 相对方创建及更新
      POST
    • 4.1 组织信息创建及更新
      POST
    • 4.2 岗位创建及更新
      POST
    • 4.3 员工创建及更新
      POST
    • 4.4 值集创建及更新
      POST
    • 4.5 独立值集值查询
      POST
    • 5.3 物料创建及更新
      POST
  • 3.合同管理
    • 查询合同关联数据[3.27-3.41]
      • 3.27 查询合同相对方
      • 3.28 查询合同关联资源
      • 3.29 查询合同关联关系
      • 3.30 查询合同租赁条款
      • 3.31 查询合同扩展信息
      • 3.32 查询合同自定义合同行
      • 3.33 查询合同行
      • 3.34 查询合同付款计划
      • 3.35 查询合同收款计划
      • 3.36 查询合同审批记录
      • 3.37 查询合同归档信息
      • 3.38 查询合同归附件
      • 3.39 查询合同授权信息
      • 3.40 查询合同正文
      • 3.41 查询合同签约信息
    • 变更[3.45-3.48]
      • 3.19 查询合同是否存在在途的变更
      • 3.45 合同老变更删除
      • 3.46 合同新变更删除
      • 3.47 旧变更提交校验接口
      • 3.48 是否可发起新变更校验接口
    • 批量下载文件
      • 批量下载文件
      • 获取文件下载链接
    • 3.4 合同文件上传
      POST
    • 3.6 模板变量查询
      POST
    • 3.7 合同正文及附件下载
      POST
    • 3.11 通过fileKey下载文件
      GET
    • 3.15 通用附件上传接口
      POST
    • 3.21 批量合同删除
      POST
    • 3.24 合同列表查询
      POST
    • 3.25 合同详情查询
      POST
    • 3.26 来源创建上传文件清空
      POST
    • 3.40 创建合同
      POST
    • 3.49 合同修改及变更
      POST
    • 合同取消归档
      POST
    • 合同履约信息更新
      POST
    • 3.50 查询合同自定义域变量
      POST
  • 6.合同履行
    • 6.4 付款计划支付回调-新合同履行
    • 6.5 付款计划创建-新合同履行
    • 6.6 收款计划查询
    • 6.7 开票信息查询
  • 7.工作流
    • 7.1 个人待办列表查询接口
    • 7.2 个人已办列表查询接口
    • 7.4 审批拒绝指定工作流
    • 7.5 审批同意指定工作流
    • 7.7 租户已办列表查询接口
    • 7.8 外部系统审批后回调
  • 数据模型
    • 创建合同-关联对象
      • 创建合同-合同相对方
      • 创建合同-合同行
      • 创建合同-自定义合同行
      • 创建合同-签约信息
      • 创建合同-签约节点信息
      • 创建合同-合同关联关系
      • 创建合同-收款计划
      • 创建合同-付款计划
      • 创建合同-拓展信息
      • 自定义域变量
    • 合同
      • 合同查询-合同对象
      • 合同关联对象查询参数
    • 主数据
      • 物料
    • 工作流
      • 工作流任务
    • 用户上下文
    • date
    • 通用返回结构
  1. 开发者指南

开发者指南(必读)

名词解释#

PM：指在项目实施过程中，甄零方的项目经理。
OC：指 onecontract 一诺合同 的缩写，代表合同系统。
值集：指维护在合同系统中的数据字典，代表一系列值和描述的列表。请求、响应字段中提供了值集编码时，可通过 4.5 独立值集值查询 API查询具体的可选项。

集成环境#

提供3套环境，体验时请使用 test 环境，项目实施进行集成测试时请使用 uat 环境，具体可咨询项目经理。
环境名称环境地址说明
测试环境(test)https://oc-test.onecontract-cloud.com/频繁迭代，不稳定
集成测试环境(uat)https://oc-uat.onecontract-cloud.com/稳定环境
生产环境(prod)https://clm.onecontract-cloud.com/稳定环境

请求与响应#

数据格式#

所有 POST、PUT 请求的数据格式默认都是 application/json

字段类型#

API 文档涉及的字段类型如下：
字段编码字段类型描述注意事项
tradingPartyMainDTOJSONObject指一个JSON对象
tradingBankDTOListJSONArray指一个JSON数组
accountTypeString字符串
activeFlagNumber自然数，如：0、1需要设置为数值，不能传字符串。如设置为1，但不能为 "1"
enableFlagBoolean布尔值，如： true 、false
amountDecimal浮点数，如：100.12
tenantIdLong长整型

通用参数#

分页查询场景
字段编码字段类型描述注意事项
pageNumber页数从0开始
sizeNumber每页数据量最大 200
分页查询结果
字段编码字段类型描述注意事项
totalElementsNumber总记录数
totalPagesNumber总页数
pageNumber当前页数
sizeNumber每页数据量
contentJSONArray数据

报文格式#

API经多次迭代，存在不同的报文结构。
响应报文1: V1 版本接口
{
    "result": { // 处理结果
        "code": "0",      // 状态码 0 表示处理成功
        "msg": "查询成功", // 提示信息
        "data": {         // 请求返回的数据
            "content": [{}], // 分页查询返回的数据
            "number": 0,  // 当前页
            "size": 100,  // 每页记录数
            "totalElements": 1, // 总记录数
            "totalPages": 1     // 总页数
        }
    },
    "success": true // 请求是否执行成功, 不代表业务操作成功
}

批处理限制#

批量新增、更新数据时，每批次不超过200条。例如：新增员工时，每批次不超过200条。

限流策略#

不同的API设定了不同级别的限流策略，以保障系统稳定性和为开发者提供最佳性能和优质的开发体验。
接口类型QPS (每秒请求数)上限QPM(每分钟请求数)上限
查询类接口3次/秒/租户60次/分钟/租户
写入类接口2次/秒/租户30次/分钟/租户
文件下载/上传接口1次/秒/租户20次/分钟/租户
当超出最大限制后，区间内将拒绝访问。例如：
qps=3, 00:00:00 超过3次，在该秒内，后续请求将全部拒绝，等待00:00:01时，将重新计算请求次数。
qpm=60，00:00 超过60次，在该分钟内，后续请求将全部拒绝，等待00:01时，将重新计算请求次数。
上线期间，可联系项目经理临时调整QPS；如需永久性提高QPS，可按需采购配额。

如何在开放平台调试？#

开放平台提供了体验专用的 客户端(Client)，可获取 token 进行测试。
各API中的请求数据一般在微调后可直接调用。
1.
以 Run In Apifox 的方式打开接口
image.png
2.选择「test-测试环境」，先通过 1.1 获取 Token 获取 Token，将自动设置到环境变量中。
image.png
3.
调试你的目标接口。
下一页
集成示例(必读)
Built with