Құжаттама

Бұл public API үшін product-facing reference. Сол identity, tenant, style version, avatar family, style options, size және WebP output major release ішінде stable қалуы керек.

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 үшін public. GET /metrics loopback-only және non-local peers үшін 404 қайтарады.

Namespace Support

Products немесе rollout phases арасында visual identity spaces бөлу үшін tenant және style_version қолдан.

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 орнына internal stable id немесе one-way application hash жібер.

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

Rate Limits

Public service origin-side rate limits қолданады; /v1/avatar/link, persist=true бар direct avatar requests және /og.png үшін limits қатаңырақ, себебі object storage writes және Open Graph image rendering direct rendering-тен қымбат.

Timeouts

Avatar generation және storage operations server-side timeouts арқылы bounded, сондықтан 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.