Dokumentasjuon

Detta ir den produktnära referensen fyr det almenna API:t. Sama identitet, tenant, stilversion, avatarfamilj, stilalternativ, storlek og WebP-utdata ir avsett at vara stabilt inom ien major-version.

Kärn-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

Drift-endpoints

GET /healthz ir almenn fyr lastbalanserare og tillgänglighetskontroller. GET /metrics ir bara tillgänglig via loopback og returnerer 404 fyr icke-lokala peers.

Namespace-stöd

Bruk tenant og style_version fyr at hålla visuella identitetsutrymmen separata mellan produkter eld utrullningsfaser.

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

Anonyma ID:n

Skicka iet stadugt internt id eld ien envägs-applikationshash i stället fyr rå persondata.

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

Hastighetsgränser

Den almenna tjänsten bruker origin-baserade hastighetsgränser, med striktare gränser fyr /v1/avatar/link, direkta avatarförfrågningar med persist=true og /og.png eftersom objektlagringsskrivningar og Open Graph-rendering ir dyrare än direkt rendering.

Timeouts

Avatar-generering og lagringsoperationer begränsas av serverbaserade timeouts so at dyra förfrågningar int kan monopolisera origin-servern obegränsat.

Fel

400: ogiltigt kind-värde, algoritm eld format som int stödjes, storlek eld saknad identitet
408: timeout vid generering eld lagring
429: hastighetsgränsen överskreds
500: renderings- eld lagringsfel

OpenAPI

Fyr genererað klienter eld verktyg, bruk /docs/openapi.json.