Entwickler-API

Die HILIA-API macht verdeckte Wasserzeichen zur Automatisierung verfügbar – markieren Sie jedes Bild in Ihrem Veröffentlichungspipeline oder scannen Sie eingehende Bilder nach Ihren Markierungen. Es handelt sich um einen kostenpflichtigen API-Schlüssel getrennt vom Webtool.

Authentifizierung

Erstellen und verwalten Sie Schlüssel unter hilia.tyo.com.au/keys (Anmeldung erforderlich). Senden der Schlüssel auf jeder Anfrage, so oder so:

Authorization: Bearer <your-api-key>

oder

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

Schlüssel können einen tragen monatliches Kontingent; Auf der Schlüsselseite wird die Verwendung als angezeigt calls used / quota. Ein widerrufener oder unbekannter Schlüssel wird erhalten 401; einen Schlüssel über Quote bekommt 429.

Endpunkte

Alle Endpunkte sind POST unter https://hilia.tyo.com.au/api/v1/ und akzeptiere multipart/form-data.

Endpunkt	Zweck	Felder
`/api/v1/wm/embed`	Betten Sie eine Text-ID ein	`image`, `key`, `text` (≤32 Byte), `strength` (optional)
`/api/v1/wm/extract`	Stellen Sie die Text-ID wieder her	`image`, `key`
`/api/v1/wm/detect`	Suchen Sie mit Zuversicht nach einer Note	`image`, `key`

Die key Feld hier ist Ihr Wasserzeichenschlüssel (das Geheimnis, an das die Marke gebunden ist) – unterscheidet sich vom API-Schlüssel, der den Aufruf authentifiziert.

Beispiel

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

Bestätigen Sie dann später, dass ein Bild Ihr Zeichen trägt:

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"

Antworten

Einbetten gibt die markierten Bildbytes zurück (gleicher Inhaltstyp wie die Eingabe).
Extrahieren und Erkennen JSON zurückgeben – der eingebettete Text oder Präsenz plus a Vertrauenswert.
Fehler: 401 ungültiger Schlüssel · 429 Kontingent überschritten · 4xx aus dem Dienst für schlecht Eingaben (nicht unterstütztes Format, übergroßer Upload).

Tip

Die Semantik der Operationen – Stärke, Überlebensfähigkeit, Einbetten vs. Erkennen – sind die das Gleiche wie im Webtool: siehe Verdecktes Wasserzeichen.