Documentație

Aceasta este referința product-facing pentru public API. Aceeași identity, tenant, style version, avatar family, style options, size și WebP output sunt menite să rămână stabile într-un 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

Endpointuri Operaționale

GET /healthz este public pentru load balancers și uptime checks. GET /metrics este loopback-only și returnează 404 pentru non-local peers.

Suport Namespace

Folosește tenant și style_version pentru a păstra visual identity spaces separate între produse sau 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-uri Anonime

Trimite un internal stable id sau one-way application hash în loc de raw personal data.

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

Rate Limits

Public service aplică origin-side rate limits, cu limite mai stricte pentru /v1/avatar/link, direct avatar requests cu persist=true și /og.png, deoarece object storage writes și Open Graph image rendering sunt mai costisitoare decât direct rendering.

Timeouts

Avatar generation și storage operations sunt limitate de server-side timeouts, astfel încât cererile costisitoare să nu poată monopoliza origin la nesfârșit.

Erori

400: kind invalid, unsupported algorithm sau format, size sau missing identity
408: generation sau storage timeout
429: rate limit exceeded
500: rendering sau storage failure

OpenAPI

Pentru generated clients sau tooling, folosește /docs/openapi.json.