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