Abundera QR Check/ เอกสารสำหรับนักพัฒนา

เอกสารสำหรับนักพัฒนา

REST API สำหรับบริการจัดประเภทความปลอดภัย QR / บาร์โค้ดของ Abundera QR Check ส่ง payload ที่ถอดรหัสแล้ว รับผลตัดสินที่ผ่านการวิเคราะห์ chain กลับมา

ข้อกำหนด API

Abundera QR Check API เป็นไปตาม OpenAPI 3.1 เรียกดูเอกสารอ้างอิงแบบโต้ตอบ ดาวน์โหลดข้อกำหนด หรือนำเข้าสู่ไคลเอ็นต์ API ที่คุณต้องการ

เอกสารอ้างอิง API แบบโต้ตอบ →
ทุก endpoint พร้อม schema คำขอ/การตอบกลับ พารามิเตอร์ และทดลองใช้งานในเบราว์เซอร์ ขับเคลื่อนโดย Scalar
OpenAPI 3.1 (YAML)
ข้อกำหนดครบถ้วนพร้อม schema, คำอธิบาย และตัวอย่าง เหมาะสำหรับเครื่องมือสร้างเอกสาร
OpenAPI 3.1 (JSON)
ข้อกำหนดเดียวกันในรูปแบบ JSON เหมาะสำหรับการใช้งานแบบโปรแกรมและเครื่องมือต่าง ๆ
Postman Collection v2.1
นำเข้าสู่ Postman หรือ Insomnia ตั้งค่าล่วงหน้าด้วยตัวแปร {{base_url}} และ {{token}}

การพิสูจน์ตัวตน

endpoint สาธารณะ POST /api/scan มีการจำกัดอัตราในระดับ anonymous (burst 10 คำขอต่อนาที, 3 คำขอต่อ 24 ชั่วโมง ต่อ IP) ระดับ Pro แบบชำระเงิน ที่จะมาพร้อมกับการเปิดตัว Founding Member จะข้ามข้อจำกัด anonymous เมื่อนำเสนอ API key เป็น bearer token:

Authorization: Bearer sk_live_abnd_check_…

API key จะถูกสร้างเมื่อสมัครสมาชิกและจัดการที่ abundera.ai/account/api-keys การตรวจสอบถูก federate ไปยัง hub และแคชใน KV เป็นเวลา 60 วินาที

Base URL และรูปแบบ

Base URL: https://check.qr.abundera.ai

รูปแบบคำขอ: JSON (Content-Type: application/json)

รูปแบบการตอบกลับ: JSON (application/json; charset=utf-8) การตอบกลับมีฟิลด์ schema_version

ตัวอย่างเร็ว

curl -X POST https://check.qr.abundera.ai/api/scan \
  -H "Content-Type: application/json" \
  -d '{"payload":"https://example.com/login"}'

การค้นพบ (well-known)

endpoint การค้นพบอัตโนมัติใต้ /.well-known/ (RFC 8615) เรียกดูดัชนีสำหรับมนุษย์หรือดึงข้อมูลโดยตรง:

ดัชนี /.well-known/ →
รายการที่อ่านได้สำหรับมนุษย์ของทุก well-known URI ที่ไซต์นี้เผยแพร่
ความสามารถ
Scopes, ระดับการจำกัดอัตรา, พื้นผิว API รวบรวมโดย UI แบบ federated ของ hub
นโยบายความปลอดภัย QR
Schema ผลตัดสินของ Check, รูปแบบที่รองรับ, ฟีดชื่อเสียง, ท่าทีความเป็นส่วนตัว
แคตตาล็อก API ของกลุ่ม →
RFC 9727 Linkset บน hub ที่แสดงรายการทุก Abundera API

ที่เกี่ยวข้อง

การครอบคลุมและรูปแบบที่รองรับ
ทุกรูปแบบ QR / บาร์โค้ดและประเภท payload ที่ scanner รู้จัก
ราคา
ระดับ Free เทียบกับ Pro, ข้อเสนอ founding member และรายละเอียดการจำกัดอัตรา
สถาปัตยกรรมความปลอดภัย
วิธีประมวลผล payload สิ่งที่แคชไว้ และท่าทีความเป็นส่วนตัว QR-17/18