hashavatar.app
დახმარება დოკუმენტაცია პირობები კონფიდენციალურობა Repository Rust Crate
API Reference

დოკუმენტაცია

ეს არის product-facing reference public API-ისთვის. იგივე identity, tenant, style version, avatar family, style options, size და WebP output major release-ის განმავლობაში stable უნდა დარჩეს.

Core Endpoints

  • GET /v1/avatar: returns an avatar asset directly
  • GET /v1/avatar/link: stores the generated avatar in configured object storage and returns signed-link metadata
  • GET /avatar/<kind>/<identity>/webp: path-style public avatar URL
  • GET /docs/openapi.json: machine-readable API description

Operational Endpoints

GET /healthz public არის load balancers-ისთვის და uptime checks-ისთვის. GET /metrics loopback-only არის და non-local peers-ისთვის 404-ს აბრუნებს.

Namespace Support

გამოიყენე tenant და style_version products-ს ან rollout phases-ს შორის visual identity spaces-ის გასაყოფად.

GET https://hashavatar.app/v1/[email protected]&tenant=acme&style_version=v2&algorithm=sha512&kind=wizard&background=white&accessory=hat&color=deep-sea-blue&expression=cool&shape=squircle&format=webp&size=256

Anonymous IDs

გააგზავნე internal stable id ან one-way application hash raw personal data-ის ნაცვლად.

printf '%s' '[email protected]' | sha256sum | cut -d' ' -f1

Rate Limits

Public service იყენებს origin-side rate limits-ს, უფრო მკაცრი limits-ით /v1/avatar/link-ისთვის, direct avatar requests persist=true-ით და /og.png-ისთვის, რადგან object storage writes და Open Graph image rendering უფრო ძვირია, ვიდრე direct rendering.

Timeouts

Avatar generation და storage operations bounded არის server-side timeouts-ით, რათა expensive requests-მა origin უსასრულოდ არ დაიკავოს.

Errors

  • 400: invalid kind, unsupported algorithm ან format, size ან missing identity
  • 408: generation ან storage timeout
  • 429: rate limit exceeded
  • 500: rendering ან storage failure

OpenAPI

Generated clients-ისთვის ან tooling-ისთვის გამოიყენე /docs/openapi.json.