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

Ова е product-facing reference за public API. Истиот identity, tenant, style version, avatar family, style options, size и WebP output треба да останат stable во 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

Operational Endpoints

GET /healthz е public за load balancers и uptime checks. GET /metrics е loopback-only и враќа 404 за non-local peers.

Namespace Support

Користи tenant и style_version за раздвојување visual identity spaces помеѓу products или 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

Anonymous IDs

Испрати 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 се bounded со server-side timeouts за expensive requests да не можат неограничено да го држат origin.

Errors

400: invalid 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.