Skjölun

Þetta er vörumiðuð tilvísun fyrir opinbera API-ið. Sama auðkenni, tenant, stílútgáfa, avatar-fjölskylda, stílstillingar, stærð og WebP-úttak eiga að vera stöðug innan major-útgáfu.

Kjarna-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

Rekstrar-endpoints

GET /healthz er opinbert fyrir load balancers og uptime-prófanir. GET /metrics er aðeins fyrir loopback og skilar 404 fyrir ekki-staðbundna peers.

Namespace-stuðningur

Notaðu tenant og style_version til að halda sjónrænum auðkennarýmum aðskildum milli vara eða rollout-fasa.

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

Nafnlaus ID

Sendu stöðugt innra id eða einstefnu application-hash í stað hrára persónuupplýsinga.

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

Rate limits

Opinbera þjónustan notar origin-side rate limits, með strangari mörkum á /v1/avatar/link, beinum avatar-beiðnum með persist=true og /og.png, því skrif í hlutageymslu og Open Graph-rendering eru dýrari en bein rendering.

Tímamörk

Avatar-myndun og geymsluaðgerðir eru afmarkaðar með server-side tímamörkum svo dýrar beiðnir geti ekki einokað origin endalaust.

Villur

400: ógilt kind-gildi, óstuddur reiknirit eða snið, stærð eða vantar auðkenni
408: tímamörk við myndun eða geymslu
429: rate limit farið yfir
500: rendering- eða geymsluvilla

OpenAPI

Fyrir myndaða clients eða verkfæri, notaðu /docs/openapi.json.