Οδηγός Ενσωμάτωσης

Βοήθεια

Χρησιμοποιήστε το hashavatar.app απευθείας από browser, frontend ή backend. Κάθε avatar URL είναι deterministic, άρα το ίδιο identifier και οι ίδιες επιλογές παράγουν πάντα το ίδιο αποτέλεσμα.

Βασικό URL

Χρησιμοποιήστε το query endpoint όταν θέλετε ένα απλό public 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

Χρησιμοποιήστε την path form αν προτιμάτε πιο καθαρά embed URLs.

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

Υποστηριζόμενες Παράμετροι

  • 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. Object-style families όπως planet, rocket, paws, mushroom, cactus, cupcake, pizza, icecream, diamond, coffee-cup και shield κανονικοποιούνται σε accessory=none και expression=default.

Signed Storage Links

Αν αυτό το deployment έχει object storage, ζητήστε presigned storage link από /v1/avatar/link. Αυτό το endpoint αποθηκεύει το generated object και επιστρέφει JSON με signed URL, object key και hashed cache key. Οι standard avatar responses δεν εκθέτουν signed-link metadata σε 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

Ο public site source βρίσκεται στο API repository και ο reusable avatar renderer δημοσιεύεται στο crates.io. Αποθετήριο · crates.io