（新）云排开放平台
  1. 前期准备
（新）云排开放平台
  • 前期准备
    • 0. 开发前必读
    • a.使用柏楚demo快速生成请求头
    • b.手动生成请求头
    • 1. api配额以及频率限制
    • 2. 数据字典
  • 零件
    • 生成零件(nc1导入)
      POST
    • 生成零件(JS模板)
      POST
    • 生成零件(DXF文件)
      POST
    • 生成零件(SmartDraw)
      POST
    • 获取全部零件列表
      POST
    • 获取排版上零件列表(按照零件物理位置顺序返回)
      POST
    • 复制零件
      POST
    • 更新和删除零件信息
      POST
    • 更新零件的自定义属性
      POST
  • 板材
    • 获取余料板层级详情
      GET
    • 添加板材
      POST
    • 获取板材列表
      POST
    • 更新板材信息
      POST
  • 图纸
    • 查询图纸信息
      POST
    • 上传dxf图纸到作业(上传文件)
      POST
    • 上传dxf图纸到作业(主动下载)
      POST
    • 删除dxf图纸(强制删除)
      POST
    • 删除dxf图纸(已处理/处理中的不可删除)
      POST
  • 材质
    • 添加材质
      POST
    • 获取材质列表
      GET
  • 作业
    • 根据作业id查询作业信息
    • 添加作业
    • 获取作业列表
    • 获取作业下零件列表
    • 获取作业下排版列表
    • 获取作业下排版详情
    • 获取作业下排产列表
    • 获取作业下零件排版信息
    • 获取作业下使用的板材列表
    • 获取作业下生产任务详情
    • 搜索作业(根据作业名称精确搜索)
    • 删除作业
    • 查询指定作业下图纸处理状态
    • 获取作业下排版详情（返回排版的dxf下载地址、零件序号）
    • 飞排
    • 根据作业id查询作业信息（平铺）
    • 删除排版
  • 生产
    • 查询机床完成任务列表
    • 获取生产任务详情
    • 服务端排产
  • 零件文字识别
    • 获取用户自定义文字识别配置
    • 图纸处理文字识别配置
  • 其他
    • 根据排版guid获取作业及板材信息
    • 根据排版guid获取零件列表
  1. 前期准备

0. 开发前必读

为了帮助开发者更快的掌握第三方平台开发，本文将就常见的基本概念进行介绍

1.术语介绍#

术语说明
appId开放平台appId
appSecret开放平台appSecret
timestampapi调用时需要提供的时间戳
appSignapi调用所需要的安全签名，基于appId、appSecret、timestamp生成，具体生成规则可参考: https://cloudopen.apifox.cn/6372615m0
X-FS-Orgcode当前对接云排样团队的orgcode
X-FS-Encode可选，返回结果编码，设置X-FS-Encode=utf-8，返回结果可以直接显示为中文
📌
appId、appSecret、appSign是OpenApi调用的基础，用于调用前的身份鉴定
X-FS-Orgcode是对接「柏楚云排样」的团队码，获取方式如下

1.1 创建企业并获取 OrgCode#

为客户企业实施对接时，需要为每家客户单独申请 OrgCode。具体步骤如下：

步骤 1：创建企业#

1.
用户登录「柏楚云排样」软件，点击右上角头像，选择 “切换到团队”：
切换到团队
2.
在弹出窗口中，点击 “创建新团队”：
创建新团队
3.
输入团队名称（通常为客户公司名称），完成创建：
输入团队名称

步骤 2：获取 OrgCode#

1.
登录「柏楚云排样」软件后，点击右上角头像，选择 “切换到团队”：
切换到团队
2.
在团队名称后方，您将看到一串字符串，即为当前团队的 OrgCode。
3.
若团队内需要增加其他用户使用云排样软件，可通过邀请的方式加入企业：
邀请成员加入

2.申请步骤#

首先进入柏楚开放平台：https://open.fscut.com/

2.1 扫码登录#

image.png

2.2 进入个人中心#

扫码登录成功后会自动进入看板模块，点击顶部菜单栏中的排样接口 - 个人中心按钮
image.png

2.3 获取appId与appSecret#

进入个人中心页面，可以直接查看您的appId
image.png
📌
appSecret为敏感信息，需要用户妥善保管

2.4 联系客服获取访问权限#

新注册的用户没有云排样接口的调用权限，需要扫码联系客服申请:
套料对接 _ Nesting API 群二维码.png
📌
联系客服后需要提供您的AppID（从个人中心复制）、营业执照、orgCode（获取方式参考1.1章节）
image.png
此刻恭喜你已经获得已经获得了使用OpenApi的所有必备条件~

3.我的第一次api调用#

📌
api的调用需要在请求头中放置：app-id、time-stamp、app-sign、X-FS-Orgcode
① app-id: 即前面获取到的appId
② time-stamp: api调用时刻前后十分钟的时间戳都可以
③ app-sign: 通过app-id、app-secret、time-stamp算出来的签名
④ X-FS-Orgcode:获取方式参考1.1章节
举例:
{
    "app-id": "op18725d72811234d2", // 复制获取到的appId
    "time-stamp": 1680592492719, // 刚刚生成appSign时使用的时间戳timeStamp
    "app-sign": "c227fc9d75471a36e3dee7bd4cc8630e" // 刚刚生成的appSign
    "X-FS-Orgcode": "A123" // 登录「柏楚云排样」软件，创建团队后获得
}

3.1 生成方式#

3.1.1 快捷方案#
考虑使用的便捷性，柏楚针对热门语言制作了请求头生成demo
可移步至: https://cloudopen.apifox.cn/6371019m0
3.1.2 手动生成#
💡
若上面快捷方案中没有你使用的语言，可以联系柏楚客服，或自己手动生成请求头
可移步至: https://cloudopen.apifox.cn/6372615m0

4 开始调用吧~#

api开放的接口可以在开放平台的接口文档模块处看到，地址：https://open.fscut.com/#/api
image.png
快找找自己感兴趣的接口吧~

4.1 注意事项#

📌
① 用户仅可调用自己设备列表中的 可支配设备，可参考辅助阅读: https://fscut-open.apifox.cn/doc-2702704
② api的调用存在 每日最大次数、频率限制，可参考辅助阅读: https://fscut-open.apifox.cn/doc-2702707
修改于 2025-07-25 10:01:26
下一页
a.使用柏楚demo快速生成请求头
Built with