Integratsioonijuhend

Abi

Kasuta hashavatar.app teenust otse brauserist, frontendist või backendist. Iga avatari URL on deterministlik, seega sama identifikaator ja valikud annavad alati sama tulemuse.

Põhi-URL

Kasuta query endpointi, kui soovid lihtsat public image URL-i.

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

Kasuta path vormi, kui eelistad puhtamaid embed URL-e.

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

HTML Näide

<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 Näide

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

Toetatud Parameetrid

  • 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 ja expression kihid rakenduvad character-style perekondadele. Object-style perekonnad nagu planet, rocket, paws, mushroom, cactus, cupcake, pizza, icecream, diamond, coffee-cup ja shield normaliseeritakse väärtustele accessory=none ja expression=default.

Allkirjastatud Salvestuslingid

Kui selles deploymentis on object storage seadistatud, küsi presigned storage linki endpointist /v1/avatar/link. See endpoint salvestab generated objecti ja tagastab JSON-i signed URL, object key ja hashed cache key väljadega. Tavalised avatar responses ei avalda signed-link metadata väärtusi response headers sees.

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

Avaliku saidi source asub API repositorys ja reusable avatar renderer avaldatakse crates.io-s. Hoidla · crates.io