Кумак

hashavatar.app-ро мустақиман аз browser, frontend ё backend истифода бар. Ҳар avatar URL deterministic аст, бинобар ин ҳамон identifier ва options ҳамеша ҳамон output медиҳанд.

Basic URL

Вақте public image URL одӣ лозим аст, query endpoint истифода бар.

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

Агар embed URLs тозатар хоҳӣ, path form истифода бар.

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

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

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 normalize мешаванд.

Signed Storage Links

Агар ин deployment object storage configured дошта бошад, аз /v1/avatar/link presigned storage link пурс. Он endpoint generated object-ро store мекунад ва JSON бо signed URL, object key ва hashed cache key бармегардонад. Standard avatar responses дар response headers signed-link metadata нишон намедиҳанд.

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

Source-и public site дар API repository аст ва reusable avatar renderer дар crates.io publish шудааст. Repository · crates.io