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 | 變量 | 格式 |
|---|---|---|
| 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 内容）
輸入變量
以下變量是全局定義的。
| 變量 | 說明 |
|---|---|
| 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 本身。將按照順序檢查所有規則。因此，最後一個匹配的規則具有優先權。使用正則表達式進行搜索。
| 變量 | 說明 |
|---|---|
| hr | 人類可讀。如果可能，將變量轉換為人類可讀的數據。預設為 TRUE 適用於 HTML、CSV 和文本格式。 |
| numdec | 小數點後的位數。 |
| numths | 千分位分隔符。 |
| numdot | 小數點分隔符。 |
| prefix | 在變量前添加文本。 |
| suffix | 在變量後添加文本。 |
路徑
在下面的章節中定義了所有 API 的應用程序。