Integracijos Vadovas

Pagalba

Naudokite hashavatar.app tiesiai iš naršyklės, savo frontendo arba backendo. Kiekvienas avataro URL yra deterministinis, todėl tas pats identifikatorius ir parinktys visada duoda tą patį rezultatą.

Paprastas URL

Naudokite query endpoint, kai reikia paprasto viešo paveikslėlio 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

Naudokite path formą, jei norite švaresnių embed URL.

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

HTML Pavyzdys

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

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

Palaikomi Parametrai

  • 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

Aksesuarų ir išraiškų sluoksniai taikomi character-style šeimoms. Object-style šeimos, tokios kaip planet, rocket, paws, mushroom, cactus, cupcake, pizza, icecream, diamond, coffee-cup ir shield, normalizuojamos į accessory=none ir expression=default.

Pasirašytos Saugyklos Nuorodos

Jei šiame deployment sukonfigūruota object storage, prašykite presigned storage link iš /v1/avatar/link. Šis endpoint išsaugo sugeneruotą objektą ir grąžina JSON su signed URL, object key ir hashed cache key. Standartiniai avataro atsakymai response headers nepateikia 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

Atvirasis Kodas

Viešos svetainės source yra API repository, o reusable avatar renderer publikuojamas crates.io. Saugykla · crates.io