ഡോക്യുമെന്റേഷൻ

ഇത് 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.