hashavatar.app
ช่วยเหลือ เอกสาร ข้อกำหนด ความเป็นส่วนตัว รีโพซิทอรี Rust crate
อ้างอิง API

เอกสาร

นี่คือเอกสารอ้างอิงเชิงผลิตภัณฑ์สำหรับ API สาธารณะ identity, tenant, เวอร์ชันสไตล์, ตระกูลอวาตาร์, ตัวเลือกสไตล์, ขนาด และผลลัพธ์ WebP เดียวกันตั้งใจให้คงที่ภายใน major version

Endpoint หลัก

  • 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

Endpoint ด้านปฏิบัติการ

GET /healthz เปิดสาธารณะสำหรับ load balancer และการตรวจ uptime ส่วน GET /metrics จำกัดเฉพาะ loopback และคืน 404 สำหรับ peer ที่ไม่ใช่ local

รองรับ namespace

ใช้ tenant และ style_version เพื่อแยกพื้นที่ identity ทางภาพระหว่างผลิตภัณฑ์หรือช่วง rollout

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

ID นิรนาม

ส่ง id ภายในที่เสถียรหรือแฮชทางเดียวของแอปแทนข้อมูลส่วนบุคคลดิบ

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

Rate limits

บริการสาธารณะใช้ rate limit ฝั่ง origin โดยมีขีดจำกัดเข้มกว่าใน /v1/avatar/link, คำขออวาตาร์โดยตรงที่มี persist=true และ /og.png เพราะการเขียน object storage และการ render Open Graph มีต้นทุนสูงกว่า render โดยตรง

Timeouts

การสร้างอวาตาร์และการทำงานกับ storage ถูกจำกัดด้วย timeout ฝั่งเซิร์ฟเวอร์ เพื่อไม่ให้คำขอที่มีต้นทุนสูงยึด origin ไว้ไม่สิ้นสุด

ข้อผิดพลาด

  • 400: kind ไม่ถูกต้อง algorithm หรือ format ไม่รองรับ ขนาดไม่ถูกต้อง หรือไม่มี identity
  • 408: การสร้างหรือ storage timeout
  • 429: เกิน rate limit
  • 500: render หรือ storage ล้มเหลว

OpenAPI

สำหรับ client ที่ generate หรือเครื่องมือ ให้ใช้ /docs/openapi.json.