Dokumentaatio

Tämä on julkisen API:n tuotelähtöinen referenssi. Sama identiteetti, tenant, tyyliversio, avatarperhe, tyyliasetukset, koko ja WebP-tulos on tarkoitettu pysymään vakaina major-version sisällä.

Keskeiset endpointit

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

Operatiiviset endpointit

GET /healthz on julkinen kuormantasaajille ja uptime-tarkistuksille. GET /metrics on vain loopback-yhteyksille ja palauttaa 404 ei-paikallisille peereille.

Namespace-tuki

Käytä tenant- ja style_version-arvoja pitääksesi visuaaliset identiteettiavaruudet erillään tuotteiden tai rollout-vaiheiden välillä.

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

Anonyymit ID:t

Lähetä vakaa sisäinen id tai yksisuuntainen sovellushash raakamuotoisten henkilötietojen sijaan.

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

Rate limitit

Julkinen palvelu käyttää origin-puolen rate limittejä, ja tiukempia rajoja endpointille /v1/avatar/link, suorille avatar-pyynnöille persist=true-parametrilla ja /og.png-endpointille, koska objektitallennuksen kirjoitukset ja Open Graph -renderöinti ovat kalliimpia kuin suora renderöinti.

Aikakatkaisut

Avatar-generointi ja tallennusoperaatiot rajataan palvelinpuolen aikakatkaisuilla, jotta kalliit pyynnöt eivät voi varata originia määräämättömäksi ajaksi.

Virheet

400: virheellinen kind-arvo, tukematon algoritmi tai formaatti, koko tai puuttuva identiteetti
408: generoinnin tai tallennuksen aikakatkaisu
429: rate limit ylitetty
500: renderöinti- tai tallennusvirhe

OpenAPI

Generoituja asiakkaita tai työkaluja varten käytä /docs/openapi.json.