hashavatar.app
እገዛ ሰነዶች ውሎች ግላዊነት Repository Rust Crate
API Reference

ሰነዶች

ይህ ለ public API product-facing reference ነው። ተመሳሳይ 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 ለ load balancers እና uptime checks public ነው። GET /metrics loopback-only ነው እና ለ non-local peers 404 ይመልሳል።

Namespace Support

በ products ወይም rollout phases መካከል visual identity spaces ለመለየት tenant እና style_version ይጠቀሙ።

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

Raw personal data በመላክ ፋንታ internal stable id ወይም one-way application hash ይላኩ።

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

Rate Limits

Public service origin-side rate limits ይተገብራል፣ ለ /v1/avatar/link, persist=true ያላቸው direct avatar requests, እና /og.png የበለጠ ጠንካራ limits አሉ፣ object storage writes እና Open Graph image rendering ከ direct rendering ይልቅ ውድ ስለሆኑ።

Timeouts

Avatar generation እና storage operations በ server-side timeouts bounded ናቸው፣ ስለዚህ 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.