Dokumentaro

Ĉi tio estas la produkt-orientita referenco por la publika API. La sama identeco, tenant, stilversio, avatara familio, stilopcioj, grandeco kaj WebP-eligo estas celitaj resti stabilaj ene de major-versio.

Ĉefaj 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

Operaciaj endpoints

GET /healthz estas publika por load balancers kaj uptime-kontroloj. GET /metrics estas nur loopback kaj redonas 404 al ne-lokaj peers.

Namespace-subteno

Uzu tenant kaj style_version por apartigi vidajn identecajn spacojn inter produktoj aŭ rollout-fazoj.

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

Anonimaj ID-oj

Sendu stabilan internan id aŭ unudirektan aplikaĵan haŝon anstataŭ krudaj personaj datumoj.

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

Rapidlimoj

La publika servo aplikas origin-flankajn rapidlimojn, kun pli striktaj limoj ĉe /v1/avatar/link, rektaj avataraj petoj kun persist=true, kaj /og.png ĉar objekt-stokaj skriboj kaj Open Graph-renderado estas pli kostaj ol rekta renderado.

Tempolimoj

Avatara generado kaj stokaj operacioj estas limigitaj per servilflankaj tempolimoj por ke kostaj petoj ne povu senfine okupi la origin.

Eraroj

400: nevalida kind, nesubtenata algoritmo aŭ formato, grandeco, aŭ mankanta identeco
408: generada aŭ stoka tempolimo
429: rapidlimo superita
500: rendera aŭ stoka fiasko

OpenAPI

Por generitaj klientoj aŭ iloj, uzu /docs/openapi.json.