Mwongozo Wa Integration

Msaada

Tumia hashavatar.app moja kwa moja kutoka browser, frontend, au backend yako. Kila avatar URL ni deterministic, hivyo identifier na options sawa hutoa matokeo yale yale kila mara.

URL Ya Msingi

Tumia query endpoint unapohitaji image URL ya umma iliyo rahisi.

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

Tumia path form ikiwa unapendelea embed URLs zilizo safi zaidi.

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

Mfano Wa 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"
/>

Mfano Wa 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();

Parameters Zinazoungwa Mkono

  • 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 na expression layers hutumika kwa character-style families. Object-style families kama planet, rocket, paws, mushroom, cactus, cupcake, pizza, icecream, diamond, coffee-cup, na shield hunormalized kuwa accessory=none na expression=default.

Signed Storage Links

Ikiwa deployment hii ina object storage iliyosanidiwa, omba presigned storage link kutoka /v1/avatar/link. Endpoint hiyo huhifadhi generated object na kurudisha JSON yenye signed URL, object key, na hashed cache key. Avatar responses za kawaida hazionyeshi signed-link metadata kwenye 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 ya public site iko kwenye API repository na reusable avatar renderer imechapishwa crates.io. Repository · crates.io