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