调用 PiQ,取回图纸。
面向设计、估算和生产系统的 API,按需生成参数化图纸。
ParametrIQ 参数化引擎,以 Web 服务形式提供
PiQ SaaS 为您自己的软件运行 ParametrIQ 图纸。发送一个模板(一张以带标签变量表示尺寸的 ParametrIQ 图纸)和您想要的数值,即可取回图纸:可以是完整图纸,可以导出为打印机、刀模制造商或切割台所需的文件,也可以计算成用于报价的数字。它与运行 ParametrIQ CAD 的是同一个引擎,因此在 ParametrIQ CAD 中绘制并测试过的模板,在这里的运行结果完全相同。
一个请求,一张图纸
每个请求都是一个模板及其数值,以 JSON 格式通过 HTTPS 发送,API 密钥放在请求头中。只有模板中带标签的变量可以赋值,且每个值都会经过检查:不是数字的长度、不在模板选项中的选择,或为模板未要求的变量提供的值,都会被拒绝,并说明是哪个值以及原因。请求之间不保留任何内容,因此相同的请求总是生成相同的图纸。
- 网络印刷和产品配置器:客户输入尺寸,即可获得校样和价格。
- 估算:在手工绘制任何内容之前,获得按类型统计的刀线长度、展开料面积、纸张利用率和刀模成本。
- 生产:将切割文件按每台机器所需的格式直接写入您的工作流程。
POST /export/pdf
X-API-KEY: your-api-key
Content-Type: application/json
{
"source": { "storage": "main", "key": "templates/rsc.piq" },
"values": { "L": 500, "W": 320, "D": 250,
"T": "C flute (4 mm)" }
}
一个 FEFCO 0201 箱子,500 × 320 × 250,C 楞:返回的是 PDF。
返回内容
文件
PDF、SVG、EPS 和 Adobe Illustrator,刀线图层为专色,以及可直接印刷的刀模线 PDF;PNG、JPEG 和 WebP 图片;用于切割台和绘图仪的 G-code、HP-GL 和 GP-GL;用于刀模制造商的 CF2 和 DDES3;用于激光机、Cricut 和 Silhouette 的 LightBurn 和 SVG;打印切割 PDF 和 EPS;用于钢结构的 DSTV NC 和 IFC;用于钣金的带折弯数据的 DXF 和 STEP;用于纸样的 AAMA/ASTM DXF;分页拼贴打印 PDF、投影仪 PDF 和缠绕式样板 PDF;卡纸切割机 DXF 和 HP-GL;用于其他 CAD 程序的 DXF。
测量数据
图纸的范围、按图层统计的切割线和压痕线长度,以及切出的展开料及其面积和周长。也可以是在图纸中计算的任何表达式:AREAOF(@1)、DISTANCE(P1,P4)、材料的补偿量。
刀模及其成本
图纸所需的钢刀模,按照 ParametrIQ CAD 的“制作刀模”的计算方式得出:按类型统计的刀线、连接点、咬口、孔、刀模板以及展开料对其的利用率,并根据您自己的价格估算成本。
模板需要的输入
模板中带标签的变量,每个变量都包含其标签、所接受的值类型,以及对于选择项可以选择的内容:足以为任何模板构建表单,而无需手工编写。
图纸本身
以 ParametrIQ 图纸文本形式提供的完整图纸,仍然是参数化的,并带有所给的数值:可在 ParametrIQ CAD 中打开以手工完成,或作为作业记录保存。
快速预览
图纸的 PNG 图片,宽度为 16 到 4000 像素:直观展示客户的尺寸会生成什么,适用于配置器、报价单或订单确认。
3D 折叠
按照 ParametrIQ 3D 视图的方式折叠的图纸:可直接用 WebGL、three.js 或游戏引擎绘制的网格,包含从平展到折叠的各个步骤,采用材料本身的外观或任一内置外观(瓦楞纸板、卡纸、硬纸板、金属、塑料、织物、木材)。
您的模板和文件,存放在您自己的存储中
只需注册一次您自己的 S3 兼容存储(AWS S3、Cloudflare R2、Backblaze B2、Wasabi、MinIO、DigitalOcean Spaces 等),并自行为其命名。之后即可将模板存放在那里,在请求中指定模板名称而无需发送模板本身,并将导出的文件直接保存到该存储,而不是下载:校样保存到客户的文件夹,切割文件保存到机器的文件夹。
- 先验证后保存:无法访问或拒绝密钥的存储不会被注册,并会告知您原因。
- 限定在其文件夹内:指定一个前缀后,键无法访问该前缀之上的位置。
- 机密信息严格保密:私密密钥以加密形式存储,且绝不会返回。
- 仅限您使用:每个订阅只能访问其自身注册的存储。
PUT /storages/main
{
"serviceUrl": "https://ACCOUNT.r2.cloudflarestorage.com",
"region": "auto",
"bucket": "my-bucket",
"prefix": "piq/",
"accessKeyId": "…",
"secretAccessKey": "…"
}
POST /save/pdf
{
"source": { "storage": "main", "key": "templates/rsc.piq" },
"values": { "L": 500 },
"destination": { "storage": "main", "key": "proofs/" }
}
可从任何系统调用
API 由 OpenAPI 文档 描述,因此可以使用 Kiota、NSwag 或 OpenAPI Generator 以大多数语言生成客户端。也可以从我们的示例入手:每个示例都会列出模板的输入项、对其进行测量、导出 PDF,并演示请求被拒绝时如何处理。
无法完成时给出明确答复
对于无法执行的请求,会以标准的问题描述进行答复:指出哪里出错,以及涉及哪个值。不做任何猜测。
保护您的限制
每个模板都有固定的运行时间,因此模板中的错误(例如永不结束的循环)会被停止并报告,而不会一直运行下去。超出服务同时处理能力的请求会排队等候;如果等待的请求过多,则会被拒绝 (429),需稍后重试。
在 ParametrIQ CAD 中绘制
模板就是普通的 ParametrIQ 图纸:在 ParametrIQ CAD 中绘制并使用“运行参数化”测试,为其所需的尺寸添加标签,即可用于 API。
获取 PiQ SaaS
订阅后,从 账户 › 许可证 复制您的 API 密钥,然后发送您的第一个请求。