Дапамога

Выкарыстоўвайце hashavatar.app непасрэдна з браузера, frontend або backend. Кожны avatar URL дэтэрмінаваны, таму той самы ідэнтыфікатар і опцыі заўсёды даюць той самы вынік.

Базавы URL

Выкарыстоўвайце query endpoint, калі патрэбны просты публічны image URL.

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

Выкарыстоўвайце path форму, калі хочаце чысцейшыя embed URL.

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

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

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

Падтрыманыя Параметры

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

Accessory і expression layers прымяняюцца да character-style families. Object-style families, такія як planet, rocket, paws, mushroom, cactus, cupcake, pizza, icecream, diamond, coffee-cup і shield, нармалізуюцца да accessory=none і expression=default.

Падпісаныя Storage Спасылкі

Калі гэты deployment мае object storage, запытайце presigned storage link з /v1/avatar/link. Гэты endpoint захоўвае generated object і вяртае JSON з signed URL, object key і hashed cache key. Стандартныя avatar responses не раскрываюць signed-link metadata ў 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

Адкрыты Код

Public site source знаходзіцца ў API repository, а reusable avatar renderer апублікаваны на crates.io. Рэпазіторый · crates.io