甄零开放平台
  1. 开发者指南
甄零开放平台
  • 开发者指南
    • 开发者指南(必读)
    • 集成示例(必读)
    • 错误码
    • 数据字典
    • 更新日志
  • 1.认证及授权
    • 1.1 获取 Token
      POST
  • 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.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.46 合同新变更删除
      • 3.47 旧变更提交校验接口
      • 3.48 是否可发起新变更校验接口
      • 3.19 查询合同是否存在在途的变更
    • 3.4 合同文件上传
      POST
    • 3.5 获取文件预览链接
      POST
    • 3.6 模板变量查询
      POST
    • 3.7 合同正文及附件下载
      POST
    • 3.11 通过fileKey下载文件
      GET
    • 3.15 通用附件上传接口
      POST
    • 3.24 合同列表查询
      POST
    • 3.40 创建合同
      POST
    • 3.26 来源创建上传文件清空
      POST
    • 3.21 批量合同删除
      POST
    • 3.49 合同修改及变更
      POST
    • 合同取消归档
      POST
    • 合同履约信息更新
      POST
  • 6.合同履行
    • 6.4 付款计划支付回调-新合同履行
    • 6.5 付款计划创建-新合同履行
    • 6.6 收款计划查询
    • 6.7 开票信息查询
  • 7.工作流
    • 7.1 个人待办列表查询接口
    • 7.2 个人已办列表查询接口
    • 7.4 审批拒绝指定工作流
    • 7.5 审批同意指定工作流
    • 7.7 租户已办列表查询接口
    • 3.43 外部系统审批后回调
  1. 开发者指南

集成示例(必读)

如何以特定用户身份访问?#

集成时默认通过 客户端模式(client_credentials)访问OC的API,不涉及到任何数据权限的控制。
若需以特定的用户身份访问接口,可以通过参数的形式指定用户上下文。
用户上下文
userIdType
enum<string> 
用户ID类型
可选
枚举值:
EMAILUSERIDLOGINNAME
userId
string 
userId
可选
userIdType=EMAIL时填邮箱,userIdType=USERID时填合同系统的USERID,userIdType=LOGINNAME时填合同系统的登录名
具体可参考 7.1 个人待办列表查询接口

如何创建一份合同?#

创建合同需要先准备好相关主数据,包含:
1.
签署部门、业务归属部门信息:可通过 4.1 组织信息创建及更新 创建部门
2.
合同经办人信息:可通过 4.2 岗位创建及更新、4.3 员工创建及更新 创建岗位、员工信息。
若集成了企微、钉钉、飞书,则可直接使用部门、员工数据。
3.上传合同相关文件:通过 3.4 合同文件上传 先上传合同的主文件和相关附件。
特别注意:sourceDocumentNumber(来源单据号) 请使用您内部系统中合同的唯一ID,该字段将与OC系统中的合同建立关联关系。
image.png
4.创建合同:通过 3.40 创建合同 创建一份合同。在请求示例中,只需要调整 sourceCode(来源单据号,和 3.4 合同文件上传 中的sourceDocumentNumber(来源单据号)一致) 即可创建一份合同,其他字段已预设好。
image.png
5.
查看处理结果
写入类接口一般都支持批量操作,处理耗时长,都为异步接口。将采用回调的形式将处理结果通过到您,支持为每个异步接口配置回调。
以创建合同为例,假设回调API为(请联系PM配置回调):https://your.domain/callback/createContract
回调报文示例:
可以根据 code+subCode 判断处理状态,根据sourceSystem+sourceCode区分来源系统和单据
image.png

如何在内部系统中预览文件?#

可通过 3.5 获取文件预览链接 通过 fileKey 获取预览链接。在浏览器新窗口中打开链接后即可预览,效果如下:
image.png
上一页
开发者指南(必读)
下一页
错误码
Built with