เอกสารอ้างอิง API

เอกสารอ้างอิงนี้อธิบายเฉพาะปลายทาง JSON ที่มีอยู่จริงและใช้งานได้แบบสาธารณะเท่านั้น -- เมธอด พาธ ประเภทการยืนยันตัวตน พารามิเตอร์ที่จำเป็น ตัวอย่างคำขอและการตอบกลับ รวมถึงรหัสข้อผิดพลาดที่บันทึกไว้ของแต่ละปลายทาง Zentor ไม่มีระบบคีย์ API สำหรับนักพัฒนาแบบทั่วไป การเข้าถึงขึ้นอยู่กับเส้นทาง คือไม่ต้องยืนยันตัวตน หรือใช้ Widget-Embed-Token พร้อมการตรวจสอบ Origin เส้นทางภายในของแดชบอร์ดและปลายทางของ Master Admin ไม่ได้เป็นส่วนหนึ่งของเอกสารอ้างอิงสาธารณะนี้โดยเจตนา เนื่องจากเข้าถึงได้ผ่านเซสชันการเข้าสู่ระบบปกติเท่านั้น

แต่ละรายการปลายทางมีบันทึกการทดสอบแบบสดที่เปิดเผยว่าข้อมูลมาจาก Registry-Schema การทดสอบอัตโนมัติ หรือการสังเกตแบบสดจริง -- ความคล้ายคลึงกับเส้นทางโค้ดที่ทำงานได้เพียงอย่างเดียวไม่ถือเป็นหลักฐานที่สมบูรณ์ นอกจากนี้ การเรียกที่สำเร็จในทางเทคนิคยืนยันเพียงการประมวลผลคำขอนั้นเท่านั้นเสมอ ไม่ได้ยืนยันกระบวนการที่ตามมาโดยอัตโนมัติ เช่น การจัดส่งอีเมล การชำระเงินเสร็จสิ้น หรือการเข้าสู่ระบบ SSO ที่เสร็จสมบูรณ์

การรักษาความปลอดภัยขึ้นอยู่กับแต่ละกลุ่ม ปลายทางด้านกฎหมาย การตลาด และแบบฟอร์มสาธารณะไม่ต้องใช้เซสชันแดชบอร์ด ในทางกลับกัน วิดเจ็ตแชทใช้ Header `X-Widget-Token` และรายการ Origin ที่อนุญาต การเข้าสู่ระบบแดชบอร์ดให้ Session-JWT ที่มีอายุสิบสองชั่วโมงและ Refresh-Token ที่ใช้ได้เจ็ดวัน ปลายทาง SSO ทำงานด้วยรหัสใช้ครั้งเดียวและขั้นตอน Callback ของตนเอง

อ่านหน้าปลายทางแต่ละหน้าเป็นสัญญาที่แยกจากกัน สิ่งสำคัญคือเมธอด HTTP พาธ พารามิเตอร์ที่จำเป็น ชนิดข้อมูล Request-Body โครงสร้างการตอบกลับ รหัสข้อผิดพลาด และ Idempotency ตัวอย่างแสดงรูปแบบที่เป็นไปได้ แต่ไม่ได้ทดแทนการตรวจสอบการตอบกลับจริง สถานะการกำหนดค่า การตรวจสอบความถูกต้อง สิทธิ์ และผู้ให้บริการภายนอกอาจเปลี่ยนแปลงผลลัพธ์ได้

Rate-Limit ทั่วทั้งแพลตฟอร์มที่ได้รับการยืนยันคือ 2,000 คำขอภายใน 15 นาที ขีดจำกัดแยกต่อปลายทางไม่ได้บันทึกไว้ครบทุกรายการ ดังนั้นไคลเอนต์ไม่ควรใช้ลูป Polling ที่ถี่เกินความจำเป็น สำหรับการดำเนินการที่ไม่เป็น Idempotent การลองซ้ำอัตโนมัติอาจสร้างชุดข้อมูลหรือข้อความซ้ำซ้อน

ค่าที่ละเอียดอ่อนไม่ควรอยู่ในบันทึก ซึ่งรวมถึงรหัสผ่าน Reset-Token รหัสยืนยัน Widget-Token Session-ID และข้อมูลตัวอย่างที่เป็นข้อมูลส่วนบุคคลจริง ใช้ค่าที่ไม่ระบุตัวตนในเอกสารและการทดสอบ หมายเหตุการทดสอบแบบสดต้องสะท้อนหลักฐานจริงอย่างถูกต้อง