Doku

Das isch d produktorientiert Referenz für d öffentlechi API. Gliichi Identität, gliiche Tenant, gliichi Stilversion, Avatar-Familie, Stiloptione, Grössi und WebP-Usgab sölle innerhalb vonere Major-Version stabil bliibe.

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

Betriebs-Endpoints

GET /healthz isch öffentlich für Load Balancer und Uptime-Prüefige. GET /metrics isch nume über Loopback erreichbar und git 404 für nöd-lokali Peers.

Namespace-Unterstützig

Nutz tenant und style_version, zum visuelli Identitätsrüüm zwüsche Produkte oder Rollout-Phase z trenne.

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

Anonymi IDs

Schick e stabiles internes ID oder en Einweg-Applikations-Hash statt rohe Personedate.

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

Rate Limits

De öffentlechi Dienst wendet origin-siiti Rate Limits aa, mit strengere Limits für /v1/avatar/link, direkti Avatar-Aafrage mit persist=true und /og.png, will Objekt-Speicher-Schriibvorgäng und Open-Graph-Rendering tüürer sind als direktes Rendering.

Timeouts

Avatar-Erzüügig und Speicheroperatione sind durch server-siiti Timeouts begrenzt, demit tüüri Aafrage de Origin nöd unbegrenzt blockiere.

Fehler

400: ungültige kind-Wert, nöd unterstützte Algorithmus oder Format, Grössi oder fehlendi Identität
408: Timeout bi Erzüügig oder Speicherig
429: Rate Limit überschritte
500: Rendering- oder Speicherfehler

OpenAPI

Für generierti Clients oder Werkzeug nutz /docs/openapi.json.