Баримт бичиг

Энэ нь 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.