C300-OpenAPI
  1. 使用指南
C300-OpenAPI
  • 使用指南
    • 快速开始(API & 事件订阅)
    • API 参考
    • 事件订阅参考
    • Webwidget使用说明
    • 制造域 MFR
      • 基础数据
        • BOM
          • API
            • 创建 BOM
            • 删除 BOM
            • 更新 BOM
            • 查询 BOM
          • 事件
            • BOM 创建
            • BOM 删除
            • BOM 更新
            • BOM 审核通过
            • BOM 审核驳回
        • 标准工序
          • API
            • 更新标准工序
            • 查询工序
            • 分批查询工序
            • 创建标准工序
            • 删除标准工序
          • 事件
            • 标准工序创建
            • 标准工序删除
            • 标准工序更新
        • 工艺路线
          • API
            • 删除工艺路线
            • 创建工艺路线
            • 更新工艺路线
            • 上传工艺路线图纸信息
            • 查询工艺路线
          • 事件
            • 工艺路线创建
            • 工艺路线删除
            • 工艺路线更新
        • 生产小组
          • API
            • 查询小组关联人员
            • 查询小组
            • 创建生产小组
            • 分批查询小组
            • 更新生产小组
            • 分批查询小组关联人员
          • 事件
        • 工作中心
          • API
            • 分批查询工作中心资源
            • 查询工作中心资源
            • 创建工作中心
            • 删除工作中心
            • 更新工作中心
            • 查询工作中心
            • 分批查询工作中心
          • 事件
        • 生产流程
          • API
          • 事件
            • 生产流程创建
            • 生产流程删除
            • 生产流程更新
      • 生产单
        • API
          • 更新生产单
          • 创建生产单
          • 批量删除生产单
          • 查询计划用料
          • 分批查询计划用料
          • 查询生产单工序
          • 修改计划用料
          • 完成生产单
          • 作废生产单
          • 查询生产单
          • 分批查询生产单
          • 创建序列号
        • 事件
          • 生产单创建
          • 生产单删除
          • 生产单更新
          • 生产单作废
          • 生产单完成
          • 生产单审核通过
          • 生产单审核驳回
          • 生产单重审
          • 生产计划用料更新
          • 生产计划用料添加
          • 生产计划用料删除
          • 生产单计划排程
          • 生产单派发
          • 生产单工序派发
          • 生产单加入计划
          • 生产单挂起
          • 生产单反挂起
      • 生产任务单
        • API
          • 查询生产任务单
          • 分批查询生产任务单
          • 查询生产任务单负责人
        • 事件
          • 生产任务流转
      • 生产领料单
        • API
          • 创建申请领料单
        • 事件
      • 生产备料出库任务
        • API
          • 更新生产备料出库任务
          • 查询生产备料出库任务
        • 事件
          • 生产备料出库任务创建
          • 生产备料出库任务删除
          • 生产备料出库任务更新
          • 生产备料出库任务审核通过
          • 生产备料出库任务审核驳回
          • 生产备料出库任务完成
      • 生产领料出库任务
        • API
          • 更新生产领料出库任务
        • 事件
      • 生产补料出库任务
        • API
          • 更新生产补料出库任务
        • 事件
      • 生产还料入库任务
        • API
          • 更新生产还料入库任务
          • 查询生产还料入库任务
        • 事件
          • 生产还料入库任务创建
          • 生产还料入库任务删除
          • 生产还料入库任务更新
          • 生产还料入库任务审核通过
          • 生产还料入库任务审核驳回
          • 生产还料入库任务完成
      • 生产入库任务
        • API
          • 查询生产入库任务
          • 更新生产入库任务
        • 事件
          • 生产入库任务创建
          • 生产入库任务删除
          • 生产入库任务更新
          • 生产入库任务完成
      • 生产报废入库任务
        • API
          • 更新生产报废入库任务
          • 完成生产报废入库任务
          • 查询报废入库
          • 分批查询报废入库
        • 事件
          • 生产报废入库任务创建
          • 生产报废入库任务删除
          • 生产报废入库任务更新
          • 生产报废入库任务完成
      • 生产报工记录
        • API
          • 删除生产报工记录
          • 创建生产报工记录
          • 查询报工记录
          • 分批查询报工记录
        • 事件
          • 生产报工记录创建
          • 生产报工记录删除
          • 生产报工记录更新
      • 委外管理
        • 委外采购单
          • API
            • 创建委外采购单
            • 更新委外采购单审核状态
            • 更新委外采购单
            • 查询委外采购单行
            • 分批查询委外采购单行
          • 事件
            • 委外采购单创建
            • 委外采购单删除
            • 委外采购单更新
            • 委外采购单审核通过
            • 委外采购单审核驳回
            • 委外采购单完成
            • 委外采购单作废
        • 委外收料单
          • API
            • 创建委外收料单
            • 创建并自动完成委外收料单
          • 事件
            • 委外收料单创建
            • 委外收料单删除
            • 委外收料单更新
            • 委外收料单审核通过
            • 委外收料单审核驳回
            • 委外收料单完成
            • 委外收料单作废
        • 委外备料出库任务
          • API
            • 更新委外备料出库任务
            • 确认委外备料出库任务
          • 事件
            • 委外备料出库任务创建
            • 委外备料出库任务删除
            • 委外备料出库任务更新
            • 委外备料出库任务完成
            • 委外备料出库任务作废
        • 委外入库任务
          • API
            • 更新委外入库任务
          • 事件
            • 生产委外入库任务创建
            • 生产委外入库任务删除
            • 生产委外入库任务更新
            • 生产委外入库任务完成
            • 生产委外入库任务作废
            • 库存委外入库任务创建
            • 库存委外入库任务删除
            • 库存委外入库任务更新
            • 库存委外入库任务完成
            • 库存委外入库任务作废
    • 认证 API
      • 创建 Token
      • 刷新 Token
    • 供应链域 SC
      • 基础数据
        • 客户
          • API
            • 创建客户
            • 删除客户
            • 更新客户
            • 查询客户列表
            • 启用客户
            • 禁用客户
            • 查询客户分类列表
            • 查询企业地址
          • 事件
            • 客户创建
            • 客户删除
            • 客户更新
            • 客户禁用
            • 客户启用
            • 客户审核通过
            • 客户审核驳回
        • 客户分类
          • API
            • 创建客户分类
            • 删除客户分类
            • 更新客户分类
            • 查询客户分类列表
          • 事件
            • 客户分类创建
            • 客户分类删除
            • 客户分类更新
        • 供应商
          • API
            • 禁用供应商
            • 启用供应商
            • 创建供应商
            • 删除供应商
            • 查询供应商
            • 更新供应商
            • 分批查询供应商
          • 事件
            • 供应商创建
            • 供应商删除
            • 供应商更新
            • 供应商禁用
            • 供应商启用
            • 供应商审核通过
            • 供应商审核驳回
        • 供应商分类
          • API
            • 创建供应商分类
            • 删除供应商分类
            • 更新供应商分类
            • 查询供应商分类
            • 分批查询供应商分类
          • 事件
            • 供应商分类创建
            • 供应商分类删除
            • 供应商分类更新
        • 销售价目表
          • API
          • 事件
            • 销售价目表创建
            • 销售价目表删除
            • 销售价目表更新
            • 销售价目表审核通过
            • 销售价目表审核驳回
        • 采购价目表
          • API
          • 事件
            • 采购价目表创建
            • 采购价目表删除
            • 采购价目表更新
            • 采购价目表审核通过
            • 采购价目表审核驳回
        • 企业地址
          • API
            • 创建企业地址
            • 删除企业地址
            • 更新企业地址
            • 查询企业地址
          • 事件
      • 销售管理
        • 销售订单
          • API
            • 创建销售订单
            • 删除销售订单
            • 更新销售订单
            • 作废销售订单
            • 查询销售订单
            • 更新销售订单审核状态
            • 完成销售订单
            • 查询订单
          • 事件
            • 销售订单创建
            • 销售订单删除
            • 销售订单更新
            • 销售订单审核通过
            • 销售订单审核驳回
            • 销售订单完成
            • 销售订单作废
            • 销售订单加入计划
        • 发货单
          • API
            • 创建发货单
            • 删除发货单
            • 更新发货单
            • 作废发货单
            • 查询发货列表
          • 事件
            • 发货单创建
            • 发货单删除
            • 发货单更新
            • 发货单审核通过
            • 发货单审核驳回
            • 发货单完成
            • 发货单作废
        • 退货单
          • API
            • 创建退货单
            • 作废并删除退货单
          • 事件
            • 退货单创建
            • 退货单删除
            • 退货单更新
            • 退货单审核通过
            • 退货单审核驳回
            • 退货单完成
            • 退货单作废
        • 销售出库任务
          • API
            • 确认销售发货出库任务
          • 事件
            • 销售出库任务创建
            • 销售出库任务删除
            • 销售出库任务更新
            • 销售出库任务完成
            • 销售出库任务作废
        • 销售退货入库任务
          • API
            • 更新销售退货入库任务
          • 事件
            • 销售退货入库任务创建
            • 销售退货入库任务删除
            • 销售退货入库任务更新
            • 销售退货入库任务完成
            • 销售退货入库任务作废
      • 采购管理
        • 采购申请单
          • API
            • 查询采购申请列表
            • 新建采购申请
            • 编辑采购申请
            • 删除采购申请
          • 事件
            • 采购申请单作废
            • 采购申请单创建
            • 采购申请单更新
            • 采购申请单删除
            • 采购申请单审核驳回
            • 采购申请单审核通过
            • 采购申请单完成
        • 采购订单
          • API
            • 创建采购订单
            • 删除采购订单
            • 更新采购订单
            • 查询采购订单
            • 作废采购订单
            • 审核采购订单
            • 获取采购单分享链接
            • 完成采购订单
          • 事件
            • 采购订单创建
            • 采购订单删除
            • 采购订单更新
            • 采购订单作废
            • 采购订单审核通过
            • 采购订单审核驳回
            • 采购订单完成
        • 采购收料单
          • API
            • 创建采购收料单
            • 删除采购收料单
            • 修改采购收料单
            • 查询采购收料单
            • 作废采购收料单
          • 事件
            • 采购收料单创建
            • 采购收料单删除
            • 采购收料单更新
            • 采购收料单作废
            • 采购收料单审核通过
            • 采购收料单审核驳回
            • 采购收料单完成
        • 采购退料单
          • API
            • 作废采购退料出库任务
            • 删除采购退料出库任务
          • 事件
            • 采购退料单删除
            • 采购退料单创建
            • 采购退料单更新
            • 采购退料单审核驳回
            • 采购退料单审核通过
            • 采购退料单完成
            • 采购退料单作废
        • 采购入库任务
          • API
            • 更新采购入库任务
            • 撤销采购入库任务
          • 事件
            • 采购入库任务创建
            • 采购入库任务删除
            • 采购入库任务更新
            • 采购入库任务完成
            • 采购入库任务作废
            • 采购检验完入库任务创建
            • 采购检验完入库任务更新
            • 采购检验完入库任务完成
            • 采购检验完入库任务作废
        • 采购退料出库任务
          • API
            • 创建采购退料出库任务
            • 创建并自动完成采购退料出库任务
          • 事件
    • 3Chat域
      • 智能体(Agent)
        • API
          • 发送消息
        • 事件
      • 渠道(Channel)
        • API
          • 发送消息
        • 事件
      • 流程(Flow)
        • API
          • Coze
      • 会话(Dialog)
        • API
          • 查询
        • 事件
          • 创建会话
      • 访客(Visitor)
        • API
          • 查询
          • 更新访客信息
        • 事件
          • 创建访客
          • 更新访客
      • 对话(Conversation)
        • API
          • 主动转人工服务
          • 查询
        • 事件
          • 创建对话
          • 更新对话
          • 再次加入对话
          • 转人工
    • 基础域DM
      • 文件管理
        • API
          • 上传文件
        • 事件
      • 低代码平台CPS
        • API
          • 查询表单详情
          • 查询表单列表
          • 保存或更新表单
          • 删除表单
      • 开发平台
        • API
          • 更新事件日志状态
    • 用户与租户域 USER
      • 员工
        • API
          • 创建员工
          • 更新员工
        • 事件
          • 员工创建
          • 员工删除
          • 员工更新
          • 员工启用
          • 员工禁用
          • 部门创建
          • 部门删除
          • 部门更新
      • 部门
        • API
          • 创建部门
          • 更新部门
        • 事件
    • 厂内物流域 LOG
      • 库存任务
        • 查询还料入库任务
        • 查询备料任务
        • 确认生产入库任务
        • 确认备料出库任务
        • 确认领料出库任务
        • 确认补料出库任务
        • 创建领料申请
        • 确认还料入库任务
        • 确认生成报废任务
        • 确认库存申请入库任务
        • 确认库存申请出库任务
        • 确认移库任务
        • 确认销售发货出库任务
        • 确认销售退货入库任务
        • 完成报废入库
        • 确认生产委外入库
        • 查询生产入库任务
      • 基础数据
        • 物料
          • API
            • 删除物料单位
            • 分页物料查询
            • 创建物料
            • 创建物料单位
            • 更新物料单位
            • 更新物料
            • 批量创建物料
            • 删除物料
            • 启用物料
            • 禁用物料
            • 更新物料审核状态
            • 上传物料图纸
            • 分页查询查询物料列表
          • 事件
            • 物料创建
            • 物料删除
            • 物料更新
            • 物料审核通过
            • 物料审核驳回
            • 物料重审
            • 物料启用
            • 物料禁用
        • 物料分类
          • API
            • 删除物料分类
            • 创建物料分类
            • 更新物料分类
            • 查询物料分类
            • 分批查询物料分类
          • 事件
            • 物料分类创建
            • 物料分类删除
            • 物料分类更新
        • 单位
          • API
            • 查询单位
            • 分批查询单位
          • 事件
            • 单位创建
            • 单位删除
            • 单位更新
        • 规格
          • API
            • 删除规格
            • 创建规格
            • 更新规格
            • 查询规格
            • 分批查询规格
          • 事件
        • 仓库
          • API
            • 创建仓库
            • 删除仓库
            • 更新仓库
            • 查询仓库
            • 分批查询仓库
          • 事件
            • 仓库创建
            • 仓库删除
            • 仓库更新
            • 仓库启用
            • 仓库禁用
        • 库位
          • API
            • 创建库位
            • 查询库位
            • 分批查询库位
          • 事件
            • 库位创建
            • 库位删除
            • 库位更新
            • 默认库位设置
      • 库存申请单
        • API
          • 删除入库申请
          • 创建出库申请单
          • 创建移库申请单
          • 作废出库申请
          • 创建入库申请单
          • 作废入库申请
          • 删除出库申请
          • 创建并自动完成出库申请单
          • 创建并自动完成移库申请单
          • 查询出库申请单
          • 创建并自动完成入库申请单
          • 查询入库申请单
        • 事件
          • 申请出库单创建
          • 申请出库单删除
          • 申请出库单更新
          • 申请出库单审核通过
          • 申请出库单审核驳回
          • 申请出库单完成
          • 申请出库单作废
          • 申请入库单创建
          • 申请入库单删除
          • 申请入库单更新
          • 申请入库单审核通过
          • 申请入库单审核驳回
          • 申请入库单完成
          • 申请入库单作废
          • 申请移库单创建
          • 申请移库单删除
          • 申请移库单更新
          • 申请移库单审核通过
          • 申请移库单审核驳回
          • 申请移库单完成
          • 申请移库单作废
      • 申请出库任务
        • API
          • 更新申请出库任务
          • 查询出库申请列表
        • 事件
          • 申请出库任务创建
          • 申请出库任务删除
          • 申请出库任务更新
          • 申请出库任务完成
          • 申请出库任务作废
      • 申请入库任务
        • API
          • 更新申请入库任务
          • 查询入库申请列表
        • 事件
          • 申请入库任务创建
          • 申请入库任务删除
          • 申请入库任务更新
          • 申请入库任务完成
          • 申请入库任务作废
      • 直接移库任务
        • API
          • 移库出入库记录
          • 更新移库任务
        • 事件
          • 申请移库任务创建
          • 申请移库任务删除
          • 申请移库任务更新
          • 申请移库任务完成
          • 申请移库任务作废
      • 物料库存
        • API
          • 查询物料可用库存明细记录
          • 【删除】查询物料库存数量
          • 查询物料库存明细信息
          • 查询物料可用库存明细记录
          • 查询物料库存明细信息
        • 事件
      • 组装拆卸单
        • API
          • 查询组装拆卸单
        • 事件
          • 组装单创建
          • 组装单删除
          • 组装单更新
          • 组装单审核通过
          • 组装单审核驳回
          • 组装单完成
          • 组装单作废
          • 拆卸单创建
          • 拆卸单删除
          • 拆卸单更新
          • 拆卸单审核通过
          • 拆卸单审核驳回
          • 拆卸单完成
          • 拆卸单作废
      • 出入库记录
        • 事件
          • 出入库记录创建
          • 出入库记录撤销
    • 质量域QLTY
      • 生产检验任务
        • 事件
          • 生产检验任务创建
          • 生产检验任务删除
          • 生产检验任务更新
      • 生产检验报工记录
        • API
          • 创建生产检验报工记录
          • 删除生产检验报工记录
          • 作废生产检验报工记录
          • 查询检验记录
          • 分批查询检验记录
          • 查询检验记录行
          • 分批查询检验记录行
        • 事件
          • 生产检验报工记录创建
          • 生产检验报工记录删除
          • 生产检验报工记录更新
      • 生产检验待处理不合格品单
        • 事件
          • 生产检验待处理不合格品单创建
          • 生产检验待处理不合格品单作废
      • 生产检验不合格品处理单
        • 事件
          • 生产检验不合格品处理单创建
          • 生产检验不合格品处理单删除
          • 生产检验不合格品处理单更新
          • 生产检验不合格品处理单审核通过
          • 生产检验不合格品处理单审核驳回
          • 生产检验不合格品处理单完成
          • 生产检验不合格品处理单作废
      • 收料待报检任务
        • 事件
          • 收料待报检任务创建
          • 收料待报检任务更新
          • 收料待报检任务作废
      • 收料检验单
        • API
          • 创建收料检验单
          • 作废收料检验单
          • 删除收料检验单
          • 更新收料检验单审核状态
        • 事件
      • 收料检验报工记录
        • 事件
          • 收料检验报工记录创建
          • 收料检验报工记录删除
      • 收料检待处理不合格品单
        • 事件
          • 收料检待处理不合格品单创建
          • 收料检待处理不合格品单作废
      • 收料检验不合格品处理单
        • 事件
          • 收料检验不合格品处理单创建
          • 收料检验不合格品处理单删除
          • 收料检验不合格品处理单更新
          • 收料检验不合格品处理单审核通过
          • 收料检验不合格品处理单审核驳回
          • 收料检验不合格品处理单完成
          • 收料检验不合格品处理单作废
      • 收料放行单
        • 事件
          • 收料放行单创建
          • 收料放行单删除
          • 收料放行单更新
          • 收料放行单审核通过
          • 收料放行单审核驳回
          • 收料放行单完成
          • 收料放行单作废
      • 收料检验库存申请单
        • 事件
          • 收料检验库存申请单创建
          • 收料检验库存申请单删除
          • 收料检验库存申请单更新
          • 收料检验库存申请单审核通过
          • 收料检验库存申请单审核驳回
          • 收料检验库存申请单完成
          • 收料检验库存申请单作废
      • 库存检验单
        • 事件
          • 库存检验单创建
          • 库存检验单删除
          • 库存检验单更新
          • 库存检验单审核通过
          • 库存检验单审核驳回
          • 库存检验单完成
          • 库存检验单作废
      • 库存检验不合格品处理单
        • 事件
          • 库存检验不合格品处理单创建
          • 库存检验不合格品处理单删除
          • 库存检验不合格品处理单更新
          • 库存检验不合格品处理单审核通过
          • 库存检验不合格品处理单审核驳回
          • 库存检验不合格品处理单完成
          • 库存检验不合格品处理单作废
    • 计划域PLN
      • 生产单计划
        • 事件
          • 生产单计划确认
      • 车间计划
        • 事件
          • 车间计划派发
          • 当前排产编辑
        • API
          • 计划派发
    • 设备域EQUIP
      • 基础数据
        • 设备
          • API
            • 创建设备
            • 更新设备
            • 删除设备
            • 查询设备
          • 事件
            • 设备创建
            • 设备删除
            • 设备更新
            • 设备分类创建
            • 设备分类删除
            • 设备分类更新
      • IOT对接
        • 对接设备数据
  • 客户案例
    • 集成案例
      • MES与畅捷通T+无缝集成,破解业财数据割离难题
      • 电子组装行业——金蝶云星空ERP与新核云MES集成案
  1. 使用指南

事件订阅参考

1. 基本概念#

1.1 事件概述#

📌
事件订阅适用于实时数据处理、快速事件响应等场景。例如:
某应用看板需要实时更新生产报工进度,希望能及时获取新核云生产报工数据,则可以订阅生产报工记录创建事件,当产生生产报工记录时,该应用可以第一时间获取报工工序、操作人、报工数量等信息,进而更新生产报工进度。
某审核应用需要及时响应生产单提交审核的数据,则可以订阅生产单创建事件。当生产单创建提交审核时,则发送审核通知信息,以便于第一时间处理审核任务。
某对接应用需要实时获取 MES 系统的生产完工入库记录,并及时推送给 ERP 系统完成相关成品库存数据的更新,则可以订阅出入库记录创建事件,当具体类型为 “生产入库” 或 “工序检验入库” 类型的出入库记录事件生成时,该应用就可以及时获取相关的生产单信息、成品数量、操作人、仓库、工序、质量状态等信息,从而保证 MES 系统和 ERP 系统的数据一致性。
同时,新核云开放平台提供了基于生产单创建信息的实时同步与自动化记录的业务场景的快速搭建教程,可以帮助您快速上手新核云开放平台事件订阅、API 调用功能与飞书工作流集成,从而实现数据实时同步与看板实时更新。

1.2 事件订阅与API调用的区别#

特性
事件订阅 (Webhook)API 调用
通信模式被动接收 (由新核云主动推送)主动获取 (由你的应用主动发起请求)
数据流向新核云 → 你的服务器你的服务器 → 新核云
最佳场景实时通知、状态同步(当某事发生时)按需查询、主动操作 (当你需要时)
时效性高 (近实时,事件触发即推送)依赖你的调用频率 (可能有过期数据)
数据关系获取事件消息 (发生了什么,通常为变更数据)获取资源状态 (是什么,通常为完整数据)
核心概念订阅 (Subscribe) 一个事件调用(Call) 一个接口
💡
用事件订阅 (Webhook):如果你需要实时感知新核云内部发生的变化(事件驱动架构)。
用 API 调用:如果你需要主动去查询信息或执行操作。
在许多复杂的集成场景中(如快速开始文档中的业务场景),两者通常结合使用:
1.
Webhook 用于触发:订阅生产单创建事件,接收实时通知。
2.
API 用于补充:收到事件后,事件数据可能只包含关键ID,再调用查询生产单 API 获取该生产单的完整详细信息。

1.3 技术架构图#

image.png
image.png

2. 消息体规范#

2.1 通用消息头 (Headers) 结构#

📌
租户 ID
人员 ID
时间戳(Timestamp)
业务类型代码
{
    "headers":{
         // 租户ID
        "TENANT_ID":[       
        ]
        // 人员ID
        "STAFF_ID":[       
        ]
         // 时间戳
        "x-nct-time":[     
        ]
         // 业务类型代码
        "business-type":[  
        ] 
}

消息头示例(采购申请单创建事件)#

{
    "headers":{
         // 租户ID
        "TENANT_ID":[
            "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"  
        ]
        "STAFF_ID":[
            "123123"    
        ]
         // 时间戳
        "x-nct-time":[
            "1750351569887"   
        ]
         // 业务类型代码
        "business-type":[
            "9120"  
        ] 
}

2.2 通用消息体 (Payload) 结构#

📌
请求 ID
业务类型
事件特定数据
{
  "requestId": "", // 请求唯一标识
  "businessType": , // 业务类型
  "data": {        //事件特定数据
  
  }
}

消息体示例(采购申请单创建事件)#

{
  "requestId": "3a528d8b-8a9f-41ac-9306-3ca84fcc2985", // 创建请求唯一标识
  "businessType": 2010, // 业务类型:采购申请单创建
  "data": {
    "id": 10558833, // 申请单唯一ID
    "code": "PR-250620-007", // 采购申请单编号(PR-年月日-流水号)
    "type": 2, // 申请单类型(整数型标识)
    "status": 0, // 申请单状态(0通常表示草稿)
    "staffCode": "EM001", // 申请人员工工号
    "createTime": 1750391230000, // 创建时间戳(毫秒)
    "comments": null, // 申请单备注说明(空值)
    "extendedFields": [], // 扩展字段列表(空数组)
    "records": [ // 申请物料明细
      {
        "id": 13178611, // 明细项ID
        "itemId": "7308337992085815296", // 物料唯一ID(长整型)
        "itemCode": "复现mrp", // 物料编码
        "itemUnit": "瓶", // 物料计量单位
        "supplierCode": "", // 建议供应商编码(空值)
        "quantity": 1, // 申请采购数量
        "confirmQuantity": 0, // 采购确认数量(初始0)
        "deadline": 1750348800000, // 物料需求截止时间
        "latestCreateOrderDate": 1750262400000, // 最晚创建采购订单时间
        "sourceOrderNumber": null, // 来源订单号(空值)
        "procedureName": null, // 相关工序名称(空值)
        "procedureCode": null, // 相关工序编码(空值)
        "extendedFields": [] // 明细扩展字段(空数组)
      }
    ]
  }
}

2.3 Webhook 推送第三方配置详解#

2.3.1 额外请求头 (Additional Headers)#

为满足不同业务场景的集成需求,本平台允许您在创建事件订阅应用时,自定义一组额外的HTTP请求头。这些请求头将与系统默认的请求头一同包含在发送给您指定Webhook地址的请求中。

默认系统请求头#

📌
无论您是否配置自定义头,新核云平台发出的所有Webhook事件请求都会包含以下系统默认头信息,用于描述事件基本元数据和进行安全验证:
Content-Type: 标识请求体的媒体类型。固定为 application/json,表明请求体为JSON格式的字符串。
Authorization(部分含有):包含Bearer Token,用于接收方验证请求的合法性。其格式为:Bearer 您的应用Secret。请注意: 此Token由系统自动生成并添加,您无需也不能在自定义头中重复配置Authorization。
TENANT_ID: 用于标识租户。
STAFF_ID: 用于标识触发事件的用户。
x-nct-time: 请求发出时的UTC时间戳(Unix Timestamp,单位为秒),用于与x-nct-sig配合进行签名验证,防止重放攻击。
x-nct-sig: 基于请求体、时间戳和您的应用Secret计算的数字签名。接收方应使用相同算法验证此签名,以确保消息未被篡改且来源可信。
business-type: 用于标识业务线。
您可以通过点击订阅事件应用的详情按钮查看 webhook 日志来查看默认系统请求头。

自定义请求头#

您可以根据自身系统的需要,在应用配置页面定义额外的键值对(Key-Value)作为自定义请求头。例如:
📌
您的Webhook接收端服务有多个版本(如v1, v2),您希望通过请求头将流量分发到不同版本进行灰度发布或A/B测试。
X-API-Version: v2.1
X-Channel: production (或 canary, staging)
完整请求头示例:
以下是一些自定义请求头的示例:
自定义请求头主要用途示例值
X-API-Version版本控制、路由v2.1, v3
Idempotency-Key幂等性控制,防重复webhook_evt_9876543210
X-Trace-ID分布式系统链路追踪00-<trace_id>-<span_id>-01
X-Event-ID事件唯一标识,用于查询event_abcd1234
X-Environment标识来源环境PROD, UAT, DEV
X-Trigger-Module标识触发业务模块MES_Work_Order, WMS_Inventory
其他任何您业务系统需要的固定标识符或令牌
您可以根据实际的业务集成需求,选择性地添加自定义头,使得Webhook的接收方能够更智能、更安全、更高效地处理事件消息。
请避免使用 Content-Type, Authorization, x-nct-time, x-nct-sig 等系统保留字段作为您的自定义头名称,以免发生冲突。系统生成的头将覆盖您自定义的同名头。

2.3.2 推送超时时间 (Timeout)#

📌
为确保平台服务的稳定性,新核云向第三方推送 Webhook 事件时有网络超时限制。
超时时间:单次推送请求的默认超时时间为 15 秒(不可在平台更改,如需更改请联系官方客服)。
重试策略:若因网络问题或接收方服务繁忙,在超时时间内未收到正确的 HTTP 200 响应,系统会自动触发重试,达到最大重试次数(3次)后新增一条失败日志记录。
最佳实践建议:
您的 Webhook 接收接口应设计为快速响应。建议在接收到事件后立即返回 HTTP 200 状态码,然后将耗时的事务处理(如写入数据库、调用其他API)放入后台队列异步执行。
请确保您的接收服务有足够的处理能力和稳定的网络,以避免因超时导致的重复推送。

2.3.3 异步更新日志状态 (Async Log Status)#

🧷
为满足客户方复杂业务处理的集成需求,新核云提供了由客户方主动触发的日志状态更新机制。
状态更新逻辑:当新核云向客户方推送Webhook事件后,若在超时时间内未收到成功的HTTP响应,平台会自动将该次推送记录为“失败”状态。此后,客户方可在其内部系统完成后续处理后,主动调用新核云提供的更新事件日志状态 API,将对应的Webhook日志状态修改为“成功”。
核心流程:
image.png
1.
新核云推送事件 -> 客户方响应超时 -> 新核云记录“失败”日志
2.
客户方异步处理业务
3.
客户方处理完成后 -> 调用“更新事件日志状态”API -> 新核云将日志状态更新为“成功”
设计目的:此设计将事件推送与业务处理解耦,允许客户方根据自身系统处理能力进行异步操作,避免因处理耗时而导致的重复推送,同时保证最终状态的可控性与一致性。

2.3.4 推送至 Coze 平台对接指南#

🌟
您可以将新核云的事件推送至 Coze 平台的工作流(Workflow),触发自动化的业务处理与响应,例如:自动通知、数据同步、智能分析或生成报告等,进一步发挥新核云产品的数据流通性与新核云 AI 智能的协同效应,提升业务效率和团队响应速度。
对接方法
1
在 Coze 中创建工作流
在 Coze 中新建工作流(如已有工作流请忽略),查询工作流 Flow ID,如下图所示:
image.png
2
在新核云中配置 Webhook 订阅
请参考事件订阅配置与流程步骤三,平台选择 COZE, 填入我们的 Flow ID,点击保存。
屏幕截图 2025-09-15 150934.png
3
在 Coze 工作流中处理事件
Webhook 触发器节点接收到新核云的事件后,其输出将成为后续节点的输入。
您可以在工作流中后续添加 LLM大模型、代码、API请求 等节点,来解析和处理新核云的事件数据,并执行所需的业务逻辑。

3. 调试技巧:查看事件订阅日志#

查看路径:开放平台 → Webhook, 点击相应事件的详情按钮,在左上角切换到 webhook 日志
屏幕截图 2025-09-15 151447.png
屏幕截图 2025-09-15 151525.png
屏幕截图 2025-09-15 152124.png
在 webhook 日志列表中选择相应事件日志,点击详情可以查看事件基本信息
屏幕截图 2025-09-15 161223.png
屏幕截图 2025-09-15 152434.png
在基本信息中点击请求参数,可以看到请求头与请求体结构。
屏幕截图 2025-09-15 152446.png
新核云开放平台也支持查看所有订阅事件日志总览,查看路径:开放平台 → Webhook → 订阅事件日志
屏幕截图 2025-09-15 164425.png
屏幕截图 2025-09-15 161505.png
📌
事件订阅重发(Resend):
针对已失败(如发送超时、接收方拒绝、网络异常等)的事件记录,主动触发一次或多次重新发送操作,尝试将事件重新传递至目标订阅方。例如:
事件因临时网络波动、接收方服务短暂不可用等原因首次发送失败;
接收方明确提示“可重试”;
需通过重发机制保障事件最终可达性。
📌
事件订阅强制成功(Force Success):
手动将状态为“失败”或“未确认”的事件强制标记为“成功”,跳过实际发送流程或覆盖原始失败状态。例如:
事件实际已发送成功,但因日志记录延迟或系统误判显示为失败;
接收方已离线但后续人工确认已通过其他渠道补传,需修正日志状态;
测试或调试场景下,跳过失败事件以快速推进流程(需谨慎使用)。
31bd335c-b58c-4c09-9967-9d9e0c6519a4.png

4. 获取帮助#

访问 新核云社区——开放平台 提问
修改于 2025-09-26 08:55:53
上一页
API 参考
下一页
Webwidget使用说明
Built with