Dokumentáció

Ez a public API termékoldali referenciája. Ugyanaz az identity, tenant, style version, avatar family, style options, size és WebP output egy major release-en belül stabilnak szánt.

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

Operációs Endpointok

A GET /healthz nyilvános load balancers és uptime checks számára. A GET /metrics loopback-only, és non-local peers esetén 404-et ad vissza.

Namespace Támogatás

Használja a tenant és style_version értékeket, hogy elkülönítse a vizuális identitási tereket termékek vagy rollout fázisok között.

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

Anonim ID-k

Küldjön belső stabil id-t vagy egyirányú application hash-t nyers személyes adat helyett.

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

Rate Limitek

A public service origin-side rate limits szabályokat alkalmaz, szigorúbb limitekkel a /v1/avatar/link, a persist=true direct avatar requests és a /og.png esetén, mert az object storage writes és Open Graph image rendering drágábbak, mint a direct rendering.

Timeouts

Az avatar generation és storage operations server-side timeouts által korlátozottak, hogy a drága kérések ne kössék le korlátlanul az origint.

Hibák

400: érvénytelen kind, nem támogatott algorithm vagy format, size, vagy hiányzó identity
408: generation vagy storage timeout
429: rate limit exceeded
500: rendering vagy storage failure

OpenAPI

Generated clients vagy tooling esetén használja /docs/openapi.json.