Integration Guide

സഹായം

hashavatar.app browser, frontend അല്ലെങ്കിൽ backend വഴി നേരിട്ട് ഉപയോഗിക്കുക. ഓരോ avatar URL ഉം deterministic ആണ്, അതിനാൽ ഒരേ identifier ഉം options ഉം എല്ലായ്പ്പോഴും ഒരേ output നൽകും.

Basic URL

ലളിതമായ public image URL ആവശ്യമുണ്ടെങ്കിൽ query endpoint ഉപയോഗിക്കുക.

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

കൂടുതൽ വൃത്തിയായ embed URLs ഇഷ്ടമാണെങ്കിൽ path form ഉപയോഗിക്കുക.

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

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

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

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

Accessory, expression layers character-style families ന് പ്രയോഗിക്കുന്നു. planet, rocket, paws, mushroom, cactus, cupcake, pizza, icecream, diamond, coffee-cup, shield പോലുള്ള Object-style families accessory=none, expression=default ആയി normalize ചെയ്യപ്പെടുന്നു.

Signed Storage Links

ഈ deployment ൽ object storage configured ആണെങ്കിൽ /v1/avatar/link ൽ നിന്ന് presigned storage link ചോദിക്കുക. ആ endpoint generated object store ചെയ്ത് signed URL, object key, hashed cache key ഉള്ള JSON മടക്കി നൽകുന്നു. Standard avatar responses response headers ൽ signed-link metadata കാണിക്കില്ല.

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

Public site source API repository യിലുണ്ട്, reusable avatar renderer crates.io ൽ publish ചെയ്തിരിക്കുന്നു. Repository · crates.io