hashavatar.app
ຊ່ວຍເຫຼືອ ເອກະສານ ເງື່ອນໄຂ ຄວາມເປັນສ່ວນຕົວ Repository Rust Crate
Integration Guide

ຊ່ວຍເຫຼືອ

ໃຊ້ hashavatar.app ໂດຍກົງຈາກ browser, frontend ຫຼື backend. ທຸກ avatar URL ເປັນ deterministic, ດັ່ງນັ້ນ identifier ແລະ options ດຽວກັນຈະໃຫ້ output ດຽວກັນສະເໝີ.

Basic URL

ໃຊ້ query endpoint ເມື່ອຕ້ອງການ 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

ໃຊ້ path form ຖ້າຕ້ອງການ embed URLs ທີ່ສະອາດກວ່າ.

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. Object-style families ເຊັ່ນ planet, rocket, paws, mushroom, cactus, cupcake, pizza, icecream, diamond, coffee-cup ແລະ shield ຖືກ normalize ເປັນ accessory=none ແລະ expression=default.

Signed Storage Links

ຖ້າ deployment ນີ້ມີ object storage configured, ຂໍ presigned storage link ຈາກ /v1/avatar/link. Endpoint ນັ້ນ store generated object ແລະ return JSON ທີ່ມີ signed URL, object key ແລະ hashed cache key. Standard avatar responses ບໍ່ເປີດເຜີຍ signed-link metadata ໃນ 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 ຂອງ public site ຢູ່ໃນ API repository ແລະ reusable avatar renderer ຖືກ publish ຢູ່ crates.io. Repository · crates.io