hashavatar.app
المساعدة التوثيق الشروط الخصوصية المستودع حزمة Rust
API Reference

التوثيق

هذا هو product-facing reference لـ public API. من المفترض أن تبقى identity وtenant وstyle version وavatar family وstyle options وsize وWebP output مستقرة ضمن major release.

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. أما GET /metrics فهو loopback-only ويعيد 404 للـ non-local peers.

دعم Namespace

استخدم tenant وstyle_version لإبقاء visual identity spaces منفصلة بين المنتجات أو rollout phases.

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

معرّفات مجهولة

أرسل 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، مع حدود أشد على /v1/avatar/link وdirect avatar requests التي تستخدم persist=true و/og.png، لأن object storage writes وOpen Graph image rendering أعلى تكلفة من direct rendering.

Timeouts

تخضع avatar generation وstorage operations إلى server-side timeouts حتى لا تستطيع الطلبات المكلفة احتكار origin بلا حد.

الأخطاء

  • 400: 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.