開發者API
HILIA API 公開了用於自動化的隱藏式浮水印 — 標記您中的每個影象 發布管道,或掃描傳入的影像以尋找標記。這是一個付費 API 金鑰 與網路工具分開。
認證
建立和管理金鑰 hilia.tyo.com.au/keys (需要登入)。傳送 每個請求的金鑰,無論哪種方式:
Authorization: Bearer <your-api-key>
或
X-Api-Key: <your-api-key>
鑰匙可攜帶 每月配額;鍵頁面顯示用法為 calls used / quota。
已撤銷或未知的金鑰 401;超過配額的金鑰得到 429.
端點
所有端點都是 POST 下 https://hilia.tyo.com.au/api/v1/ 並接受
multipart/form-data.
| 端點 | 目的 | 領域 |
|---|---|---|
/api/v1/wm/embed | 嵌入文字 ID | image, key, text (≤32位元組), strength (可選) |
/api/v1/wm/extract | 恢復文字ID | image, key |
/api/v1/wm/detect | 自信地檢查標記 | image, key |
的 key 這裡的欄位是你的 水印鍵 (標記被鎖定的秘密)—
與驗證呼叫的 API 金鑰不同。
範例
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
然後,稍後確認影象帶有您的標記:
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"
回應
- 嵌入 傳回標記的影象位元組(與輸入相同的內容型別)。
- 萃取物 和 偵測 傳回 JSON — 嵌入的文字,或存在加上 置信度得分。
- 錯誤:
401無效金鑰·429超出配額·4xx從服務不好 輸入(不支援的格式、過大的上傳)。
Tip
操作的語意——強度、生存能力、嵌入與檢測——是 與網路工具中的相同:參見 隱蔽浮水印.