Dogfennaeth

Dyma'r product-facing reference ar gyfer y public API. Dylai'r un identity, tenant, style version, avatar family, style options, size a WebP output aros yn stable drwy 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

Mae GET /healthz yn public ar gyfer load balancers ac uptime checks. Mae GET /metrics yn loopback-only ac yn dychwelyd 404 i non-local peers.

Namespace Support

Defnyddiwch tenant a style_version i wahanu visual identity spaces rhwng products neu 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

Anonymous IDs

Anfonwch internal stable id neu one-way application hash yn lle raw personal data.

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

Rate Limits

Mae'r public service yn gorfodi origin-side rate limits, gyda limits llymach ar gyfer /v1/avatar/link, direct avatar requests gyda persist=true, a /og.png gan fod object storage writes ac Open Graph image rendering yn ddrutach na direct rendering.

Timeouts

Mae avatar generation a storage operations wedi'u bounded gan server-side timeouts fel na all expensive requests ddal yr origin heb derfyn.

Errors

400: invalid kind, unsupported algorithm neu format, size, neu missing identity
408: generation neu storage timeout
429: rate limit exceeded
500: rendering neu storage failure

OpenAPI

Ar gyfer generated clients neu tooling, defnyddiwch /docs/openapi.json.