hashavatar.app
Ndihmë Dokumentim Kushtet Privatësia Repository Rust Crate
API Reference

Dokumentim

Ky është product-facing reference për public API. I njëjti identity, tenant, style version, avatar family, style options, size dhe WebP output pritet të mbeten stable gjatë 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 është public për load balancers dhe uptime checks. GET /metrics është loopback-only dhe kthen 404 për non-local peers.

Namespace Support

Përdor tenant dhe style_version për të ndarë visual identity spaces mes products ose 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

Anonymous IDs

Dërgo internal stable id ose one-way application hash në vend të raw personal data.

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

Rate Limits

Public service zbaton origin-side rate limits, me limits më të rrepta për /v1/avatar/link, direct avatar requests me persist=true dhe /og.png sepse object storage writes dhe Open Graph image rendering janë më të kushtueshme se direct rendering.

Timeouts

Avatar generation dhe storage operations janë bounded nga server-side timeouts që expensive requests të mos mbajnë origin pa kufi.

Errors

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

OpenAPI

Për generated clients ose tooling, përdor /docs/openapi.json.