API relatio

Documenta

Haec est relatio ad productum spectans pro API publico. Eadem identitas, tenant, versio stili, familia avataris, optiones stili, magnitudo, et output WebP intra versionem maiorem stabiles manere destinantur.

Endpoints principales

  • 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

Endpoints operationales

GET /healthz publicum est pro load balancers et probationibus uptime. GET /metrics solum loopback est et 404 peeribus non-localibus reddit.

Auxilium namespace

Utere tenant et style_version ut spatia identitatis visualis inter productos vel tempora rollout separata teneas.

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

ID anonyma

Mitte id internum stabile vel hash applicationis unius viae pro datis personalibus crudis.

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

Limites frequentiae

Ministerium publicum limites frequentiae in origine applicat, cum limitibus strictioribus in /v1/avatar/link, petitionibus avataris directis cum persist=true, et /og.png quia scripturae repositorii objectorum et rendering Open Graph pretiosiora sunt quam rendering directum.

Tempora finita

Generatio avatarum et operationes repositorii limitibus temporis in servo clauduntur, ne petitiones pretiosae originem sine fine occupent.

Errores

  • 400: kind invalidum, algorithmus vel forma non sustentata, magnitudo, aut identitas deest
  • 408: tempus generationis vel repositorii finitum
  • 429: limen frequentiae superatum
  • 500: defectus rendering vel repositorii

OpenAPI

Pro clientibus generatis vel instrumentis, utere /docs/openapi.json.