Дакументацыя

Гэта product-facing reference для public API. Тыя самыя identity, tenant, style version, avatar family, style options, size і WebP output прызначаны заставацца стабільнымі ў major release.

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

Аперацыйныя Endpoints

GET /healthz публічны для load balancers і uptime checks. GET /metrics — loopback-only і вяртае 404 для non-local peers.

Namespace Падтрымка

Выкарыстоўвайце tenant і style_version, каб трымаць visual identity spaces асобна паміж прадуктамі або 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

Адпраўляйце internal stable id або one-way application hash замест raw personal data.

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

Rate Limits

Public service прымяняе origin-side rate limits, з больш строгімі limits для /v1/avatar/link, direct avatar requests з persist=true і /og.png, бо object storage writes і Open Graph image rendering даражэйшыя за direct rendering.

Timeouts

Avatar generation і storage operations абмежаваны server-side timeouts, каб дарагія запыты не маглі бясконца займаць origin.

Памылкі

400: няправільны kind, unsupported algorithm або format, size або missing identity
408: generation або storage timeout
429: rate limit exceeded
500: rendering або storage failure

OpenAPI

Для generated clients або tooling выкарыстоўвайце /docs/openapi.json.