Antcas API
Antcas API 允许在多个应用程序之间交换数据。
| 警告： 在使用此 API 时请注意安全。仅使用 TLS 并永远不要在公开可访问的地址上使用端口。 |
说明： 每次调用 API 均需检查令牌，这可能会导致系统负载增加。
设置 API 端口
在 项目管理下可以添加一个新的
API 端口。有关说明，请参阅章节 将端口分配给项目。
为了能够创建一个请求，必须使用 令牌进行身份验证。如何创建令牌在章节 管理令牌 中有详细说明。
格式和值
API 支持多种输入格式：HTTP 查询、 JSON 和 XML。输出可以是 HTML、文本、JSON 或 XML。字符编码始终为 UTF-8。
说明： 通过浏览器中的元素调用会导致错误 428（Precondition Required）。这是 XSS 攻击防护，无法绕过。它可以防止对 Antcas Control 的黑客攻击。
在 POST 或 PUT 请求中，数据可以通过相应格式的内容写入。每个变量都是区分大小写的，这意味着需要区分大写和小写字母。但返回值始终以声明的格式返回。输出格式可以通过标头或变量 format 描述。输入格式总是自动识别的。
GET /visu/var/eid?format=json&token=tokenid HTTP/1.1
Host: serveraddr.com
Content-Type: application/json
以下格式在标头和变量 format 中受支持：
| Content-Type | Variable | Format |
|---|---|---|
| application/json | json | JSON |
| application/xml | xml | XML |
| text/plain | text | 文本 |
| text/csv | csv | CSV* |
| (其他) | html | HTML |
*仅作为输出格式受支持。
说明： 文本和 CSV 格式包含 UTF-8 BOM。可以使用变量 bom=FALSE 禁用它。
如果一个值通过多种格式描述，则后者具有优先级：
- HTTP 标头（仅输出格式通过 Content-Type）
- GET
- POST
- JSON/XML（作为 POST 或 PUT 内容）
输入变量
以下变量是全局定义的。
| Variable | 描述 |
|---|---|
| format | 输出格式。 |
| bom | UTF-8 格式中的 BOM。默认值为 TRUE。 |
| key | 仅读取已声明的变量。此方法效率低下，因为所有数据均需准备好才能过滤。它应仅用于小型数据集。 |
| header | 输出标头。默认值为 TRUE。 |
| compact | 将所有子元素合并到一起。如果未声明布尔值，则使用该值来合并变量。否则，将使用值 .。 |
| values | 仅返回值而不返回变量名。此选项仅适用于 HTML、CSV 和文本。 |
| minimal | header=FALSE、compact=minimal 和 values=TRUE 的别名。 |
| csvdel | CSV 分隔符。默认值为 ; |
| csvenc | CSV 封闭括号。默认值为 " |
| csvesc | CSV 转义字符。默认值为 \ |
以下变量可以全局使用，也可用于单个变量。要引用一个单独的变量，请如下所述定义：
time*:hr=true
上述示例调用所有以 time 开头的变量和 time 本身。将检查所有规则按顺序进行。因此，最后一个匹配的规则具有优先级。使用正则表达式搜索。
| Variable | 描述 |
|---|---|
| hr | 人类可读。如果可能，变量将转换为适合人类阅读的数据。默认值为 TRUE，适用于 HTML、CSV 和文本格式。 |
| numdec | 小数点后的位数。 |
| numths | 千分位分隔符。 |
| numdot | 小数点分隔符。 |
| prefix | 在变量前添加文本。 |
| suffix | 在变量后添加文本。 |
路径
在下面的章节中定义了所有 API 的应用程序。