Ҳуҷҷатҳо

Ин product-facing reference барои public API аст. Ҳамон 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

Барои ҷудо кардани visual identity spaces байни products ё rollout phases 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, direct avatar requests бо persist=true ва /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.