Helpo

Uzu hashavatar.app rekte el la retumilo, via frontendo aŭ via backendo. Ĉiu avatara URL estas determinisma, do la sama identigilo kaj opcioj ĉiam produktas la saman rezulton.

Baza URL

Uzu la query-endpoint kiam vi volas simplan publikan bildan URL-on.

https://hashavatar.app/v1/[email protected]&algorithm=sha512&kind=robot&background=white&accessory=glasses&color=gold&expression=happy&shape=circle&format=webp&size=256

Voja-forma URL

Uzu la vojan formon se vi preferas pli purajn enmetajn URL-ojn.

https://hashavatar.app/avatar/fox/[email protected]/webp

HTML-ekzemplo

<img
  src="https://hashavatar.app/v1/[email protected]&algorithm=sha512&kind=monster&background=themed&accessory=horns&color=crimson&expression=grumpy&shape=hexagon&format=webp&size=256"
  alt="Generated monster avatar"
/>

JavaScript-ekzemplo

const avatarUrl = new URL("https://hashavatar.app/v1/avatar");
avatarUrl.search = new URLSearchParams({
  id: user.email,
  algorithm: "sha512",
  kind: "robot",
  background: "white",
  accessory: "glasses",
  color: "gold",
  expression: "happy",
  shape: "circle",
  format: "webp",
  size: "256",
}).toString();

Subtenataj parametroj

id: any stable identifier such as an email, username, internal user id, or one-way hash
tenant: optional namespace partition for multi-tenant apps
style_version: optional style namespace such as v2
algorithm: identity hash mode; only sha512 is supported
kind: any public hashavatar family, including cat, dog, robot, planet, rocket, frog, panda, cupcake, pizza, octopus, knight, bear, penguin, dragon, ninja, astronaut, diamond, coffee-cup, and shield
background: themed, white, black, dark, light, transparent, polka-dot, striped, checkerboard, grid, sunrise, ocean, or starry
accessory: none, glasses, hat, headphones, crown, bowtie, eyepatch, scarf, halo, or horns
color: default, neon-mint, pastel-pink, crimson, gold, or deep-sea-blue
expression: default, happy, grumpy, surprised, sleepy, winking, cool, or crying
shape: square, circle, squircle, hexagon, or octagon
format: output format; only webp is supported
size: from 64 up to 1024

Akcesoraĵaj kaj mienaj tavoloj aplikiĝas al karakter-stilaj familioj. Objekt-stilaj familioj kiel planet, rocket, paws, mushroom, cactus, cupcake, pizza, icecream, diamond, coffee-cup kaj shield estas normaligitaj al accessory=none kaj expression=default.

Subskribitaj stokaj ligiloj

Se ĉi tiu deployment havas objektan stokadon agorditan, petu antaŭsubskribitan stokan ligilon de /v1/avatar/link. Tiu endpoint stokas la generitan objekton kaj redonas JSON kun la subskribita URL, objekta ŝlosilo kaj haŝita kaŝmemora ŝlosilo. Normaj avataraj respondoj ne malkaŝas subskribit-ligilan metadata en response headers.

GET https://hashavatar.app/v1/avatar/[email protected]&algorithm=sha512&kind=robot&background=white&accessory=glasses&color=gold&expression=happy&shape=circle&format=webp&size=256

Malferma fonto

La fonto de la publika retejo troviĝas en la API-deponejo kaj la reuzebla avatara renderilo estas publikigita ĉe crates.io. Deponejo · crates.io