Hujjatlar

Bu public API uchun product-facing reference. Bir xil identity, tenant, style version, avatar family, style options, size va WebP output major release davomida stable qolishi kerak.

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 va uptime checks uchun public. GET /metrics loopback-only va non-local peers uchun 404 qaytaradi.

Namespace Support

Products yoki rollout phases orasida visual identity spaces ajratish uchun tenant va style_version ishlat.

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

Raw personal data o‘rniga internal stable id yoki one-way application hash yubor.

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

Rate Limits

Public service origin-side rate limits qo‘llaydi; /v1/avatar/link, persist=true bo‘lgan direct avatar requests va /og.png uchun limits qattiqroq, chunki object storage writes va Open Graph image rendering direct rendering-dan qimmatroq.

Timeouts

Avatar generation va storage operations server-side timeouts bilan bounded, shunda expensive requests origin-ni cheksiz ushlab turolmaydi.

Errors

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

OpenAPI

Generated clients yoki tooling uchun ishlat /docs/openapi.json.