Руководство по интеграции

Помощь

Используйте hashavatar.app прямо из браузера, frontend или backend. Каждый URL аватара детерминирован, поэтому один и тот же идентификатор и опции всегда дают один результат.

Базовый URL

Используйте query endpoint, когда нужен простой публичный 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

URL в path-форме

Используйте path-форму, если предпочитаете более чистые 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

Слои аксессуаров и выражений применяются к персонажным семействам. Объектные семейства вроде planet, rocket, paws, mushroom, cactus, cupcake, pizza, icecream, diamond, coffee-cup и shield нормализуются к accessory=none и expression=default.

Подписанные ссылки хранения

Если в этом deployment настроено объектное хранилище, запросите presigned storage link через /v1/avatar/link. Endpoint сохраняет созданный объект и возвращает JSON с подписанным URL, object key и хэшированным cache key. Стандартные ответы аватаров не раскрывают 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

Исходный код публичного сайта находится в API repository, а переиспользуемый avatar renderer опубликован на crates.io. Репозиторий · crates.io