API nhà phát triển

API HILIA hiển thị hình mờ bí mật để tự động hóa - đánh dấu mọi hình ảnh trong quy trình xuất bản hoặc quét hình ảnh đến để tìm nhãn hiệu của bạn. Đó là khóa API trả phí tách biệt khỏi công cụ web.

Xác thực

Tạo và quản lý khóa tại hilia.tyo.com.au/keys (yêu cầu đăng nhập). Gửi chìa khóa cho mọi yêu cầu, dù bằng cách nào:

Authorization: Bearer <your-api-key>

hoặc

X-Api-Key: <your-api-key>

Chìa khóa có thể mang theo một hạn ngạch hàng tháng; trang khóa hiển thị cách sử dụng như calls used / quota. Một khóa bị thu hồi hoặc không xác định sẽ được 401; một chìa khóa vượt quá hạn ngạch được 429.

Điểm cuối

Tất cả các điểm cuối đều POST dưới https://hilia.tyo.com.au/api/v1/ và chấp nhận multipart/form-data.

Điểm cuối	Mục đích	Trường
`/api/v1/wm/embed`	Nhúng ID văn bản	`image`, `key`, `text` (<32 byte), `strength` (tùy chọn)
`/api/v1/wm/extract`	Khôi phục ID văn bản	`image`, `key`
`/api/v1/wm/detect`	Kiểm tra điểm một cách tự tin	`image`, `key`

các key trường ở đây là của bạn phím hình mờ (bí mật mà nhãn hiệu bị khóa) — khác với khóa API xác thực cuộc gọi.

Ví dụ

curl -X POST https://hilia.tyo.com.au/api/v1/wm/embed \
  -H "Authorization: Bearer $HILIA_API_KEY" \
  -F "[email protected]" \
  -F "key=$WATERMARK_KEY" \
  -F "text=order-8841" \
  -o product-shot-marked.jpg

Sau đó, hãy xác nhận hình ảnh mang dấu ấn của bạn:

curl -X POST https://hilia.tyo.com.au/api/v1/wm/detect \
  -H "Authorization: Bearer $HILIA_API_KEY" \
  -F "[email protected]" \
  -F "key=$WATERMARK_KEY"

Phản hồi

Nhúng trả về các byte hình ảnh được đánh dấu (cùng loại nội dung với đầu vào).
Trích xuất và Phát hiện trả về JSON — văn bản được nhúng hoặc sự hiện diện cộng với một điểm tự tin.
Lỗi: 401 khóa không hợp lệ · 429 vượt quá hạn ngạch · 4xx từ dịch vụ xấu đầu vào (định dạng không được hỗ trợ, tải lên quá khổ).

Tip

Ngữ nghĩa của các hoạt động - sức mạnh, khả năng sống sót, Nhúng và Phát hiện - là giống như trong công cụ web: xem Hình mờ bí mật.