Panduan Integrasi

Bantuan

Gunakan hashavatar.app langsung dari browser, frontend, atau backend Anda. Setiap avatar URL deterministik, sehingga identifier dan opsi yang sama selalu menghasilkan hasil yang sama.

URL Dasar

Gunakan query endpoint saat Anda membutuhkan image URL publik sederhana.

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

Tautan Penyimpanan Bertanda Tangan

Jika deployment ini memiliki object storage yang dikonfigurasi, minta presigned storage link dari /v1/avatar/link. Endpoint itu menyimpan generated object dan mengembalikan JSON dengan signed URL, object key, dan hashed cache key. Avatar responses standar tidak mengekspos signed-link metadata di 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 ada di API repository dan reusable avatar renderer dipublikasikan di crates.io. Repositori · crates.io