Vodnik Za Integracijo

Pomoč

Uporabite hashavatar.app neposredno iz brskalnika, svojega frontenda ali backenda. Vsak avatar URL je determinističen, zato isti identifikator in možnosti vedno ustvarijo isti rezultat.

Osnovni URL

Uporabite query endpoint, ko želite preprost javni 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

Uporabite path obliko, če imate raje čistejše embed URL-je.

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

HTML Primer

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

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();

Podprti Parametri

  • 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 in expression layers veljajo za character-style families. Object-style families, kot so planet, rocket, paws, mushroom, cactus, cupcake, pizza, icecream, diamond, coffee-cup in shield, se normalizirajo na accessory=none in expression=default.

Podpisane Povezave Za Shranjevanje

Če ima ta deployment konfiguriran object storage, zahtevajte presigned storage link iz /v1/avatar/link. Ta endpoint shrani generated object in vrne JSON s signed URL, object key in hashed cache key. Standardni avatar responses ne razkrivajo signed-link metadata v 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

Vir javnega mesta je v API repository, reusable avatar renderer pa je objavljen na crates.io. Repozitorij · crates.io