Doiciméadú

Seo an product-facing reference don public API. Tá sé i gceist go bhfanfaidh identity, tenant, style version, avatar family, style options, size agus WebP output cobhsaí laistigh de major release.

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

Tá GET /healthz poiblí do load balancers agus uptime checks. Tá GET /metrics loopback-only agus filleann sé 404 do non-local peers.

Tacaíocht Namespace

Úsáid tenant agus style_version chun visual identity spaces a choinneáil scartha idir táirgí nó rollout phases.

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

IDanna Anaithnide

Seol internal stable id nó one-way application hash in ionad raw personal data.

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

Rate Limits

Cuireann an public service origin-side rate limits i bhfeidhm, le teorainneacha níos déine ar /v1/avatar/link, direct avatar requests le persist=true, agus /og.png toisc go bhfuil object storage writes agus Open Graph image rendering níos costasaí ná direct rendering.

Timeouts

Tá avatar generation agus storage operations teoranta le server-side timeouts ionas nach féidir le hiarratais chostasacha an origin a mhonaplú gan teorainn.

Earráidí

400: kind neamhbhailí, unsupported algorithm nó format, size nó missing identity
408: generation nó storage timeout
429: rate limit exceeded
500: rendering nó storage failure

OpenAPI

Do generated clients nó tooling, úsáid /docs/openapi.json.