Panduan Integrasi

Bantuan

Gunakan hashavatar.app terus daripada browser, frontend, atau backend anda. Setiap avatar URL deterministik, jadi identifier dan pilihan yang sama sentiasa menghasilkan output yang sama.

URL Asas

Gunakan query endpoint apabila anda perlukan image URL awam yang ringkas.

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

Gunakan bentuk path jika anda lebih suka embed URLs yang lebih bersih.

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

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

Contoh 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 Disokong

  • 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 dan expression layers digunakan untuk character-style families. Object-style families seperti planet, rocket, paws, mushroom, cactus, cupcake, pizza, icecream, diamond, coffee-cup, dan shield dinormalisasi kepada accessory=none dan expression=default.

Pautan Storan Bertandatangan

Jika deployment ini mempunyai object storage yang dikonfigurasi, minta presigned storage link daripada /v1/avatar/link. Endpoint itu menyimpan generated object dan mengembalikan JSON dengan signed URL, object key, dan hashed cache key. Avatar responses biasa tidak mendedahkan signed-link metadata dalam 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 laman awam berada dalam API repository dan reusable avatar renderer diterbitkan di crates.io. Repositori · crates.io