Dokumentatsioon

See on public API tootepoolne viide. Sama identity, tenant, style version, avatar family, style options, size ja WebP output on mõeldud püsima stabiilsena major release piires.

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

Operatsioonilised Endpointid

GET /healthz on public load balancers ja uptime checks jaoks. GET /metrics on loopback-only ning tagastab non-local peers puhul 404.

Namespace Tugi

Kasuta tenant ja style_version väärtusi, et hoida visuaalse identiteedi ruumid eraldi toodete või rollout etappide vahel.

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

Anonüümsed ID-d

Saada raw personal data asemel internal stable id või one-way application hash.

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

Rate Limits

Public service rakendab origin-side rate limits reegleid, rangemate limitidega /v1/avatar/link, persist=true direct avatar requests ja /og.png jaoks, sest object storage writes ja Open Graph image rendering on kulukamad kui direct rendering.

Timeouts

Avatar generation ja storage operations on piiratud server-side timeouts abil, et kallid päringud ei saaks originit lõputult hõivata.

Vead

400: vigane kind, unsupported algorithm või format, size või missing identity
408: generation või storage timeout
429: rate limit exceeded
500: rendering või storage failure

OpenAPI

Generated clients või tooling jaoks kasuta /docs/openapi.json.