Integration Guide

Laguntza

Erabili hashavatar.app zuzenean browser, frontend edo backend-etik. Avatar URL bakoitza deterministic da, beraz identifier eta options berdinek beti output bera ematen dute.

Basic URL

Erabili query endpoint public image URL sinple bat behar duzunean.

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

Erabili path form embed URLs garbiagoak nahi badituzu.

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

HTML Adibidea

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

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 eta expression layers character-style families-etarako aplikatzen dira. Object-style families hala nola planet, rocket, paws, mushroom, cactus, cupcake, pizza, icecream, diamond, coffee-cup eta shield accessory=none eta expression=default gisa normalize egiten dira.

Signed Storage Links

Deployment honek object storage configured badu, eskatu presigned storage link bat /v1/avatar/link bidez. Endpoint horrek generated object store egiten du eta signed URL, object key eta hashed cache key dituen JSON itzultzen du. Standard avatar responses-ek ez dute signed-link metadata response headers-etan erakusten.

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-n dago, eta reusable avatar renderer crates.io-n publish dago. Repository · crates.io