Integration Guide

Tulong

Gamitin ang hashavatar.app direkta mula sa browser, frontend, o backend mo. Deterministic ang bawat avatar URL, kaya ang parehong identifier at options ay laging magbibigay ng parehong output.

Basic URL

Gamitin ang query endpoint kapag kailangan mo ng simpleng public image URL.

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

Gamitin ang path form kung mas gusto mo ng mas malinis na embed URLs.

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

HTML Example

<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 Example

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

Ang accessory at expression layers ay ginagamit sa character-style families. Object-style families tulad ng planet, rocket, paws, mushroom, cactus, cupcake, pizza, icecream, diamond, coffee-cup, at shield ay normalized sa accessory=none at expression=default.

Signed Storage Links

Kung may configured object storage ang deployment na ito, humingi ng presigned storage link mula sa /v1/avatar/link. Ini-store ng endpoint ang generated object at nagbabalik ng JSON na may signed URL, object key, at hashed cache key. Hindi inilalabas ng standard avatar responses ang signed-link metadata sa 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

Ang source ng public site ay nasa API repository at ang reusable avatar renderer ay naka-publish sa crates.io. Repository · crates.io