Dokumentācija

Šī ir produkta līmeņa atsauce public API. Tas pats identity, tenant, style version, avatar family, style options, size un WebP output ir paredzēti stabilitātei major release ietvaros.

Galvenie Endpointi

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

Operacionālie Endpointi

GET /healthz ir publisks load balancers un uptime checks vajadzībām. GET /metrics ir tikai loopback un ne-vietējiem peers atgriež 404.

Namespace Atbalsts

Izmantojiet tenant un style_version, lai nodalītu vizuālās identitātes telpas starp produktiem vai rollout posmiem.

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

Anonīmi ID

Sūtiet iekšēju stabilu id vai vienvirziena application hash nevis neapstrādātus personas datus.

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

Rate Limits

Public service piemēro origin-side rate limits; stingrāki limiti ir /v1/avatar/link, direct avatar requests ar persist=true un /og.png, jo object storage writes un Open Graph image rendering ir dārgāki nekā direct rendering.

Timeouts

Avatar generation un storage operations tiek ierobežotas ar server-side timeouts, lai dārgi pieprasījumi nevarētu bezgalīgi aizņemt origin.

Kļūdas

400: nederīgs kind, neatbalstīts algorithm vai format, size vai trūkst identity
408: generation vai storage timeout
429: rate limit pārsniegts
500: rendering vai storage failure

OpenAPI

Generated clients vai tooling izmantojiet /docs/openapi.json.