0. 开发前必读

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

1.术语介绍

术语	说明
appId	开放平台appId
appSecret	开放平台appSecret
timestamp	api调用时需要提供的时间戳
appSign	api调用所需要的安全签名，基于`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：创建企业

用户登录「柏楚云排样」软件，点击右上角头像，选择 “切换到团队”：

在弹出窗口中，点击 “创建新团队”：

输入团队名称（通常为客户公司名称），完成创建：

步骤 2：获取 OrgCode

在团队名称后方，您将看到一串字符串，即为当前团队的 OrgCode。

若团队内需要增加其他用户使用云排样软件，可通过邀请的方式加入企业：
邀请成员加入

2.申请步骤

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

2.1 扫码登录

2.2 进入个人中心

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

2.3 获取appId与appSecret

进入个人中心页面，可以直接查看您的appId

📌

appSecret为敏感信息，需要用户妥善保管

2.4 联系客服获取访问权限

新注册的用户没有云排样接口的调用权限，需要扫码联系客服申请:

📌

联系客服后需要提供您的AppID（从个人中心复制）、营业执照、orgCode（获取方式参考1.1章节）

此刻恭喜你已经获得已经获得了使用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

快找找自己感兴趣的接口吧~

4.1 注意事项

📌

① 用户仅可调用自己设备列表中的 可支配设备，可参考辅助阅读: https://fscut-open.apifox.cn/doc-2702704
② api的调用存在 每日最大次数、频率限制，可参考辅助阅读: https://fscut-open.apifox.cn/doc-2702707

1.术语介绍#

1.1 创建企业并获取 OrgCode#

步骤 1：创建企业#

步骤 2：获取 OrgCode#

2.申请步骤#

2.1 扫码登录#

2.2 进入个人中心#

2.3 获取appId与appSecret#

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

3.我的第一次api调用#

3.1 生成方式#

3.1.1 快捷方案#

3.1.2 手动生成#

4 开始调用吧~#

4.1 注意事项#