အကူအညီ

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 အတွက်အသုံးပြုသည်။ planet, rocket, paws, mushroom, cactus, cupcake, pizza, icecream, diamond, coffee-cup, shield ကဲ့သို့သော Object-style families များကို accessory=none နှင့် expression=default အဖြစ် normalize လုပ်သည်။

Signed Storage Links

ဤ deployment တွင် object storage configured ဖြစ်ပါက /v1/avatar/link မှ presigned storage link တောင်းပါ။ ထို endpoint သည် generated object ကို store လုပ်ပြီး signed URL, object key, hashed cache key ပါသော JSON ကိုပြန်ပေးသည်။ 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

Public site source သည် API repository တွင်ရှိပြီး reusable avatar renderer ကို crates.io တွင် publish ထားသည်။ Repository · crates.io