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

อินเทอร์เฟซสำหรับนักพัฒนา: เอนด์พอยต์สาธารณะ, แชทวิดเจ็ต, การเข้าสู่ระบบ และ REST API พร้อมคีย์ API

API Reference อธิบายอินเทอร์เฟซของ Zentor App ที่คุณสามารถเรียกใช้จากเว็บไซต์และโปรแกรมของคุณเองได้: เอนด์พอยต์สาธารณะสำหรับฟอร์ม ตัวกำหนดค่าผลิตภัณฑ์ และเนื้อหา แชทวิดเจ็ต แชทบอทสาธิต และการเข้าสู่ระบบรวมถึง Single Sign-On หน้าเอนด์พอยต์แต่ละหน้าจะระบุเมธอด พาธ การยืนยันตัวตน พารามิเตอร์ ตัวอย่างคำขอและการตอบกลับ และโค้ดข้อผิดพลาดที่มีการบันทึกไว้

การยืนยันตัวตน: เอนด์พอยต์สำหรับฟอร์ม ตัวกำหนดค่าผลิตภัณฑ์ และเนื้อหาสามารถเรียกใช้ได้โดยไม่ต้องเข้าสู่ระบบ เอนด์พอยต์ของแชทวิดเจ็ตต้องการ Embed Token ของวิดเจ็ตของคุณในส่วนหัว `X-Widget-Token` และรับคำขอเฉพาะจากโดเมนที่ได้รับการอนุมัติสำหรับวิดเจ็ตนั้นเท่านั้น เอนด์พอยต์การเข้าสู่ระบบจะออก Access Token (JWT) และ Refresh Token สำหรับเซสชันผู้ใช้

การเข้าถึง API ด้วยคีย์ API: สำหรับโปรแกรมของคุณเองและการเชื่อมต่อแบบเซิร์ฟเวอร์ต่อเซิร์ฟเวอร์ REST API พร้อมใช้งานที่ Base URL `https://zentor-app.de/api/v1` Zentor จะเปิดใช้งานการเข้าถึง API สำหรับบัญชีของคุณตามคำขอ หลังจากนั้นผู้ดูแลระบบจะสร้างคีย์ของตนเองในแดชบอร์ดที่ “คีย์ API” และกำหนดสิทธิ์ (scope) ของคีย์นั้น – สำหรับนัดหมายและการจอง แชทบอท การสื่อสาร ไฟล์ ฐานความรู้ รายงาน และข้อมูลเว็บ แต่ละพื้นที่มี scope สำหรับอ่าน (`<พื้นที่>.read`, เฉพาะ GET) และ scope สำหรับเขียน (`<พื้นที่>.write`, รวมถึงการอ่าน) เช่น `appointments.read` หรือ `knowledge.write` ส่งคีย์ในส่วนหัว `Authorization: Bearer <คีย์ API>` หรือใช้ส่วนหัว `X-API-Key` แทนได้ ใช้ `GET /api/v1/me` เพื่อตรวจสอบว่าคีย์นั้นผูกกับบัญชีและ scope ใด

คีย์แบบเต็มจะแสดงเพียงครั้งเดียวตอนสร้าง เก็บไว้อย่างปลอดภัยและเฉพาะที่ฝั่งเซิร์ฟเวอร์เท่านั้น ห้ามใส่ในโค้ดเบราว์เซอร์หรือแอปมือถือโดยเด็ดขาด คีย์สามารถกำหนดวันหมดอายุ หมุนเวียน และเพิกถอนได้ ผ่าน REST API จะเข้าถึงได้เฉพาะฟังก์ชันที่รวมอยู่ในแพ็กเกจของคุณ และข้อมูลทั้งหมดจะถูกจำกัดไว้เฉพาะบัญชีของคุณ ข้อผิดพลาดที่พบบ่อย: 401 `API_KEY_INVALID`, `API_KEY_EXPIRED` หรือ `API_KEY_REVOKED` (คีย์หายไป ผิด หมดอายุ หรือถูกเพิกถอน), 403 `API_ACCESS_NOT_ENABLED` (ยังไม่เปิดใช้งานการเข้าถึง API สำหรับบัญชี), 403 `API_SCOPE_MISSING` (คีย์ไม่มี scope ที่จำเป็น), 403 `TENANT_NOT_ACTIVE` หรือ `TENANT_LOCKED` (บัญชีไม่ได้ใช้งานอยู่หรือถูกล็อก) และ 404 `API_ENDPOINT_NOT_AVAILABLE` (เอนด์พอยต์ไม่สามารถใช้งานผ่าน REST API ได้)

การตอบกลับและข้อจำกัด: ทุกเอนด์พอยต์ตอบกลับด้วย JSON การตอบกลับที่สำเร็จจะมีสถานะ 2xx และ `"ok": true`; การตอบกลับที่มีข้อผิดพลาดจะมีโค้ดข้อผิดพลาดที่เครื่องอ่านได้ (ในฟิลด์ `error` หรือ `error.code`) และข้อความ แต่ละที่อยู่ IP สามารถส่งคำขอได้ 2,000 ครั้งภายใน 15 นาที เอนด์พอยต์สำหรับฟอร์ม การยืนยัน และการเข้าสู่ระบบมีข้อจำกัดที่เข้มงวดกว่า ซึ่งระบุไว้ในแต่ละหน้า หากเกินขีดจำกัด เซิร์ฟเวอร์จะตอบกลับด้วย 429 `RATE_LIMIT_EXCEEDED` เอนด์พอยต์ที่ระบุว่าไม่ใช่ idempotent ไม่ควรลองซ้ำโดยอัตโนมัติหลังจากการเชื่อมต่อขาดหาย เพราะอาจทำให้เกิดคำขอหรือข้อความซ้ำซ้อน

ส่งรหัสผ่าน โทเค็น คีย์ API และโค้ดยืนยันเฉพาะใน request body หรือส่วนหัวผ่าน HTTPS เท่านั้น – ห้ามส่งใน URL บันทึก หรือคำขอการสนับสนุนโดยเด็ดขาด

การยืนยันตัวตน (5)การเข้าสู่ระบบ การต่ออายุโทเค็น การรีเซ็ตรหัสผ่าน การเสร็จสิ้น SSO – และการเข้าถึง API ด้วยคีย์ APIฟอร์มสาธารณะ (11)ติดต่อ, คำขอรับคำปรึกษา, คำขอเข้าถึง, การชำระเงิน และการเปิดใช้งานบัญชีตัวกำหนดค่าผลิตภัณฑ์ (5)แคตตาล็อกแพ็กเกจ, ตัวอย่างราคา, การยืนยันอีเมล และการส่งการกำหนดค่าเนื้อหาสาธารณะ (6)เอกสารทางกฎหมาย, เพจการตลาด, ธีมเว็บไซต์ และสีข้อความแชทวิดเจ็ต (9)เอนด์พอยต์ทั้งหมดที่แชทวิดเจ็ตที่ฝังในเว็บไซต์ของคุณใช้แชทบอทสาธิตและ SSO (13)แชทบอทสาธิตสาธารณะและเอนด์พอยต์ Single Sign-On (SAML/OIDC)
← กลับสู่ภาพรวม