Antcas API

Antcas API cho phép trao đổi dữ liệu giữa nhiều ứng dụng.

CẢNH BÁO: Hãy chú ý đến bảo mật khi sử dụng API này. Chỉ sử dụng TLS và không bao giờ sử dụng cổng trên một địa chỉ công khai.

Ghi chú: Vì API phải kiểm tra token mỗi lần gọi, điều này có thể dẫn đến tải hệ thống cao hơn.

Cài đặt một cổng API

Bạn có thể thêm một cổng API mới trong Quản lý dự án. Mô tả chi tiết được tìm thấy trong chương Gán cổng cho dự án.

Để tạo một yêu cầu, nó phải được xác thực bằng Token. Tạo token được giải thích chi tiết trong chương Quản lý Token.

Định dạng và giá trị

API hỗ trợ nhiều định dạng đầu vào: HTTP-Queries, JSON và XML. Kết quả có thể là HTML, Text, JSON hoặc XML. Mã hóa ký tự luôn là UTF-8.

Ghi chú: Một cuộc gọi từ một phần tử trong trình duyệt sẽ dẫn đến lỗi 428 (Precondition Required). Đây là bảo vệ chống XSS-Attack, không thể vượt qua được. Nó ngăn chặn tấn công hack vào Antcas Control.

Khi thực hiện yêu cầu POST hoặc PUT, dữ liệu có thể được viết trong nội dung theo định dạng tương ứng. Mỗi biến là Case Sensitive, nghĩa là phân biệt chữ hoa và thường. Tuy nhiên, kết quả trả về luôn theo định dạng đã khai báo. Định dạng đầu ra có thể được mô tả thông qua Header hoặc biến format. Định dạng đầu vào sẽ tự động được nhận diện.

GET /visu/var/eid?format=json&token=tokenid HTTP/1.1
Host: serveraddr.com
Content-Type: application/json

Các định dạng sau được hỗ trợ trong Header và biến format:

Content-Type Biến Định dạng
application/json json JSON
application/xml xml XML
text/plain text Text
text/csv csv CSV*
(khác) html HTML

*Chỉ được hỗ trợ như định dạng đầu ra.

Ghi chú: Định dạng Text và CSV chứa UTF-8 BOM. Nó có thể bị vô hiệu hóa bằng biến bom=FALSE.

Nếu một giá trị được mô tả qua nhiều định dạng, định dạng cuối cùng sẽ ưu tiên:

  • HTTP-Header (chỉ định dạng đầu ra thông qua Content-Type)
  • GET
  • POST
  • JSON/XML (nội dung POST hoặc PUT)

Biến đầu vào

Các biến sau được định nghĩa toàn cục.

Biến Mô tả
format Định dạng đầu ra.
bom BOM trong định dạng UTF-8. Giá trị mặc định là TRUE.
key Chỉ đọc một biến đã được khai báo. Phương pháp này không hiệu quả vì tất cả dữ liệu phải được chuẩn bị và lọc sau đó. Nó chỉ nên được sử dụng với lượng dữ liệu nhỏ.
header Xuất header. Giá trị mặc định là TRUE.
compact Gộp tất cả các phần tử con lại với nhau. Nếu không khai báo giá trị boolean, giá trị này sẽ được sử dụng để gộp biến. Ngược lại, giá trị . sẽ được sử dụng.
values Chỉ trả về giá trị và không trả về tên biến. Tùy chọn này chỉ có sẵn cho HTML, CSV và Text.
minimal Bí danh cho header=FALSE, compact=minimal và values=TRUE.
csvdel CSV-Delimiter. Giá trị mặc định là ;
csvenc CSV-Enclosure-Klammern. Giá trị mặc định là "
csvesc CSV-Escape-Zeichen. Giá trị mặc định là \

Các biến sau có thể được sử dụng toàn cục, cũng như cho các biến riêng lẻ. Để gọi một biến riêng lẻ, nó được định nghĩa như sau:

time*:hr=true

Ví dụ trên gọi tất cả các biến bắt đầu bằng time và time chính nó. Tất cả quy tắc đều được kiểm tra theo thứ tự. Quy tắc phù hợp cuối cùng sẽ ưu tiên. Tìm kiếm được thực hiện bằng biểu thức chính quy.

Biến Mô tả
hr Human Readable. Biến sẽ được chuyển đổi thành dữ liệu có thể đọc được bởi con người nếu có thể. Giá trị mặc định là TRUE cho định dạng HTML, CSV và Text.
numdec Số chữ số sau dấu phẩy.
numths Ký tự phân cách hàng nghìn.
numdot Ký tự phân cách thập phân.
prefix Thêm văn bản trước biến.
suffix Thêm văn bản sau biến.

Đường dẫn

Trong các chương dưới đây, tất cả các ứng dụng của API được định nghĩa.

Trang con