API de desarrollador

La API HILIA expone marcas de agua encubiertas para la automatización: marque cada imagen en su canal de publicación o escanear imágenes entrantes para obtener sus marcas. Es una API paga con clave por separado de la herramienta web.

Autenticación

Cree y administre claves en hilia.tyo.com.au/keys (es necesario iniciar sesión). enviar la clave en cada solicitud, de cualquier manera:

Authorization: Bearer <your-api-key>

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

Las llaves pueden llevar un cuota mensual; la página de claves muestra el uso como calls used / quota. Una clave revocada o desconocida se obtiene 401; se obtiene una clave por encima de la cuota 429.

Puntos finales

Todos los puntos finales son POST bajo https://hilia.tyo.com.au/api/v1/ y aceptar multipart/form-data.

Punto final	Propósito	Campos
`/api/v1/wm/embed`	Insertar una identificación de texto	`image`, `key`, `text` (≤32 bytes), `strength` (opcional)
`/api/v1/wm/extract`	Recuperar la identificación de texto	`image`, `key`
`/api/v1/wm/detect`	Busque una marca con confianza	`image`, `key`

el key campo aquí está tu clave de marca de agua (el secreto al que está encerrada la marca) - distinta de la clave API que autentica la llamada.

Ejemplo

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

Luego, más tarde, confirma que una imagen lleva tu marca:

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"

Respuestas

Insertar devuelve los bytes de imagen marcados (mismo tipo de contenido que la entrada).
Extracto y detectar devolver JSON: el texto incrustado o la presencia más un puntuación de confianza.
Errores: 401 clave no válida · 429 cuota superada · 4xx del servicio para mal entradas (formato no compatible, carga de gran tamaño).

Tip

La semántica de las operaciones (fuerza, capacidad de supervivencia, Insertar vs Detectar) es la igual que en la herramienta web: ver Marca de agua encubierta.