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