Mosaqo API
API สาธารณะและ webhooks สำหรับระบบอัตโนมัติของ QR
Mosaqo Public API ใช้คีย์ที่กำหนดขอบเขตพื้นที่ทำงาน เริ่มต้นด้วยขอบเขตขั้นต่ำ ใช้ Idempotency-Key สำหรับการเขียนและดำเนินการ Retry-After เมื่ออัตราจำกัด
ภาพรวมโดยย่อ
สิ่งนี้เปลี่ยนอะไรในทางปฏิบัติ
01
การรับรองความถูกต้องและขอบเขต
ส่งความลับใน X-Mosaqo-API-Key ขอบเขตที่ใช้ได้ ได้แก่ qr:read, qr:write,exports:read และ analytics:read คีย์สามารถหมดอายุ ถูกเพิกถอน หรือใช้รายการอนุญาต IP
- อย่าวางความลับใน JavaScript ของไคลเอ็นต์
- ใช้หนึ่งคีย์ต่อการรวมระบบ
- หมุนหลังจากได้รับสารที่ต้องสงสัย
02
ลองเขียนใหม่อย่างปลอดภัย
คำขอสร้างและเผยแพร่ต้องใช้ Idempotency-Key ที่มีความยาวระหว่าง 1 ถึง 128 อักขระ ใช้คีย์ซ้ำเพื่อลองเพย์โหลดที่เหมือนกันอีกครั้งภายใน 24 ชั่วโมง
03
ขีดจำกัดอัตราและข้อผิดพลาด
บน HTTP 429 ให้อ่าน Retry-After แล้วลองอีกครั้งโดย Backoff โดยทั่วไปแล้ว 401 จะระบุว่าคีย์หายไป ถูกเพิกถอน หมดอายุ ถูกจำกัดหรือมีการกำหนดขอบเขตไม่เพียงพอ
04
เว็บฮุค
สมัครสมาชิกเฉพาะกิจกรรมที่จำเป็น ยอมรับบน HTTPS และตอบกลับอย่างรวดเร็ว Mosaqo บันทึกสถานะการนำส่งและรองรับการเล่นซ้ำจากพื้นที่ทำงาน
FAQ
คำถามที่พบบ่อย
สัญญา API ฉบับสมบูรณ์อยู่ที่ไหน
สัญญา OpenAPI 3.1 มีการกำหนดเวอร์ชันด้วย Mosaqo API สร้างคีย์ในพื้นที่ทำงานบนเว็บและใช้สัญญาที่เผยแพร่สำหรับรายละเอียดปลายทาง
ขั้นตอนถัดไป