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`	Вставить текстовый идентификатор	`image`, `key`, `text` (≤32 байт), `strength` (необязательно)
`/api/v1/wm/extract`	Восстановить идентификатор текста	`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

Семантика операций — сила, живучесть, внедрение или обнаружение — являются то же, что и в веб-инструменте: см. Скрытые водяные знаки.