Cymorth

Defnyddiwch hashavatar.app yn uniongyrchol o'ch browser, frontend neu backend. Mae pob avatar URL yn deterministic, felly mae'r un identifier ac options bob amser yn rhoi'r un output.

Basic URL

Defnyddiwch y query endpoint pan fydd angen public image URL syml arnoch.

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

Path Style URL

Defnyddiwch y path form os yw'n well gennych embed URLs glanach.

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

Enghraifft HTML

<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"
/>

Enghraifft JavaScript

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();

Supported Parameters

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

Mae accessory ac expression layers yn cael eu cymhwyso i character-style families. Mae Object-style families fel planet, rocket, paws, mushroom, cactus, cupcake, pizza, icecream, diamond, coffee-cup a shield yn cael eu normalize i accessory=none ac expression=default.

Signed Storage Links

Os oes gan y deployment hwn object storage configured, gofynnwch am presigned storage link o /v1/avatar/link. Mae'r endpoint hwnnw'n store y generated object ac yn dychwelyd JSON gyda signed URL, object key a hashed cache key. Nid yw standard avatar responses yn datgelu signed-link metadata mewn 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

Open Source

Mae source y public site yn yr API repository ac mae'r reusable avatar renderer wedi'i publish ar crates.io. Repository · crates.io