開発者API
HILIA API は、自動化のための秘密の透かしを公開します。 パイプラインを公開するか、受信した画像をスキャンしてマークを探します。キー付きの有料 API です Web ツールとは別に。
認証
キーの作成と管理は次のとおりです。 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
操作のセマンティクス (強度、生存可能性、埋め込みと検出) は次のとおりです。 Web ツールと同じ: を参照してください。 秘密の透かし.