Документация

Это product-facing reference для публичного API. Одинаковые identity, tenant, style version, avatar family, style options, size и WebP output должны оставаться стабильными в пределах major version.

Core endpoints

GET /v1/avatar: returns an avatar asset directly
GET /v1/avatar/link: stores the generated avatar in configured object storage and returns signed-link metadata
GET /avatar/<kind>/<identity>/webp: path-style public avatar URL
GET /docs/openapi.json: machine-readable API description

Operational endpoints

GET /healthz публичен для load balancers и uptime checks. GET /metrics доступен только через loopback и возвращает 404 для non-local peers.

Поддержка namespace

Используйте tenant и style_version, чтобы разделять визуальные пространства идентичности между продуктами или rollout phases.

GET https://hashavatar.app/v1/[email protected]&tenant=acme&style_version=v2&algorithm=sha512&kind=wizard&background=white&accessory=hat&color=deep-sea-blue&expression=cool&shape=squircle&format=webp&size=256

Анонимные ID

Отправляйте стабильный внутренний id или односторонний application hash вместо сырых персональных данных.

printf '%s' '[email protected]' | sha256sum | cut -d' ' -f1

Rate limits

Публичный сервис применяет origin-side rate limits, с более строгими лимитами для /v1/avatar/link, direct avatar requests с persist=true и /og.png, потому что object storage writes и Open Graph rendering дороже прямого rendering.

Timeouts

Avatar generation и storage operations ограничены server-side timeouts, чтобы дорогие requests не могли бесконечно занимать origin.

Ошибки

400: некорректный kind, неподдерживаемый algorithm или format, size или отсутствующий identity
408: generation или storage timeout
429: rate limit превышен
500: rendering или storage failure

OpenAPI

Для generated clients или tooling используйте /docs/openapi.json.