Pandhuan Integrasi

Pitulung

Gunakake hashavatar.app langsung saka browser, frontend, utawa backend sampeyan. Saben avatar URL deterministik, mula identifier lan opsi sing padha mesthi ngasilake asil sing padha.

URL Dhasar

Gunakake query endpoint nalika sampeyan butuh image URL publik sing prasaja.

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

Gunakake wangun path yen luwih seneng embed URLs sing luwih resik.

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

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

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

Parameter Sing Didukung

  • 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 lan expression layers ditrapake kanggo character-style families. Object-style families kayata planet, rocket, paws, mushroom, cactus, cupcake, pizza, icecream, diamond, coffee-cup, lan shield dinormalisasi dadi accessory=none lan expression=default.

Tautan Panyimpenan Ditandatangani

Yen deployment iki duwe object storage sing dikonfigurasi, jaluk presigned storage link saka /v1/avatar/link. Endpoint kasebut nyimpen generated object lan mbalekake JSON nganggo signed URL, object key, lan hashed cache key. Avatar responses standar ora nampilake signed-link metadata ing 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

Source situs publik ana ing API repository lan reusable avatar renderer diterbitake ing crates.io. Repository · crates.io