客户端
API 由一份 OpenAPI 文档描述,因此可以使用 Kiota、NSwag 或 OpenAPI Generator 等生成器为大多数语言生成客户端:请参阅 OpenAPI。不过,它使用的是普通的 HTTPS 和 JSON,因此也可以同样轻松地使用任何语言自带的 HTTP 客户端来调用,这里的示例就是这样做的。
无论使用哪种语言,每个请求都在 X-API-KEY 标头中携带您的密钥:请参阅
使用 API 密钥。
示例
每个示例都是一个完成相同工作的完整程序,便于相互比较:
- 从
PIQ_API_KEY环境变量读取您的 API 密钥,并从PIQ_URL读取服务地址(未设置时为https://saas.parametriq.co.uk)。 - 列出模板中带标签的变量(
POST /inputs):模板是一个 400 × 300 的矩形,其长度L和宽度W带有标签。 - 以
L为 500、W为 250 测量图纸(POST /measure):得到其宽度、高度和切割长度。 - 将图纸导出为 PDF(
POST /export/pdf),保存为box.pdf,并打印X-PiQ-Warnings标头。 - 可选:当
PIQ_STORAGE指定了您已注册的某个存储时,从该存储读取模板(source),并同时将 PDF 保存到该存储(POST /save/pdf)。
任何不成功的请求都会使程序停止:它会打印状态和问题描述(其 title、detail,以及来自 errors 的哪个值有什么问题),并以非 0 的代码退出。401(密钥不正确)没有问题描述,因此只打印状态。
每个页面都有可供阅读的程序以及下载链接。
- JavaScript:Node.js 18 或更高版本,使用其内置的
fetch;无需任何包。 - Python:Python 3,使用
requests。 - C#:.NET,使用
HttpClient和System.Net.Http.Json;单文件控制台程序。 - Go:Go,仅使用标准库。
- Java:Java 17 或更高版本,使用
java.net.http;无需任何库。 - PHP:PHP 8,使用 curl 扩展。
- Ruby:Ruby 3,使用标准库中的
net/http。 - curl:一个 bash 脚本,使用 curl 和 jq。
运行前,请先在环境中设置您的密钥:在 bash 中使用 export PIQ_API_KEY=XXXX-XXXX-XXXX-XXXXX,或在
PowerShell 中使用 $env:PIQ_API_KEY = "XXXX-XXXX-XXXX-XXXXX"。不要把密钥写在程序本身中。
每个示例中的模板都是 API 中的那个:
L=400,"Length"
W=300,"Width"
P1=[L,0]
P2=[L,W]
P3=[0,W]
POLYLINE @1,[P0,P1,P2,P3],TRUE,0