Integration Guide

Yordam

hashavatar.app-ni browser, frontend yoki backend orqali bevosita ishlat. Har bir avatar URL deterministic, shuning uchun bir xil identifier va options har doim bir xil output beradi.

Basic URL

Oddiy public image URL kerak bo‘lsa query endpoint ishlat.

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

Tozaroq embed URLs xohlasang path form ishlat.

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

HTML Namuna

<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 Namuna

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 va expression layers character-style families uchun qo‘llanadi. Planet, rocket, paws, mushroom, cactus, cupcake, pizza, icecream, diamond, coffee-cup va shield kabi object-style families accessory=none va expression=default qilib normalize qilinadi.

Signed Storage Links

Bu deployment ichida object storage configured bo‘lsa, /v1/avatar/link orqali presigned storage link so‘ra. Bu endpoint generated object-ni store qiladi va signed URL, object key hamda hashed cache key bilan JSON qaytaradi. Standard avatar responses response headers ichida signed-link metadata ko‘rsatmaydi.

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 ichida, reusable avatar renderer esa crates.io-da publish qilingan. Repository · crates.io