REST / HTTPS
สไตล์ API เดียวกันสำหรับคลาวด์และเกตเวย์ท้องถิ่น แลกเปลี่ยนข้อมูล JSON
แพลตฟอร์มนักพัฒนา ไพร์พอยท์ สมารท์ ให้ RESTful API มาตรฐานและ SDK เปิดสำหรับ integrator ผู้ขาย PMS/CRS และ ISV — ครอบคลุมการเชื่อมต่ออุปกรณ์ สถานะห้อง ควบคุมฉาก ข้อมูลพลังงาน และการสมัครรับเหตุการณ์ ผ่านคลาวด์หรือเกตเวย์ท้องถิ่น ฝังการควบคุมห้องพัก ไพร์พอยท์ สมารท์ เข้ากับการดำเนินงานโรงแรมและระบบจัดการอาคารได้อย่างรวดเร็ว
ดาวน์โหลด SDK และเอกสาร · แพลตฟอร์มจัดการคลาวด์ · ขอ API keys
ความสามารถของแพลตฟอร์ม
-
RESTful API
คำขอ/ตอบ JSON ผ่าน HTTPS เส้นทางมีเวอร์ชัน — ผสานรวมง่ายสำหรับ front-end, back-end และระบบบุคคลที่สาม
-
SDK หลายภาษา
ตัวอย่าง Java, Python และ Node.js พร้อมเครื่องมือลงนาม ลดรอบการผสานรวมและ go-live
-
เหตุการณ์ Webhook
การเปลี่ยนสถานะห้อง การแจ้งเตือน และผลฉากส่งแบบ proactive — พร้อม retry และตรวจสอบลายเซ็น
-
Sandbox
ผู้เช่าทดสอบเฉพาะและอุปกรณ์จำลองสำหรับการผสานรวมก่อน production และตรวจสอบโหลด (สมัครเพื่อเปิดใช้)
โมดูล API
อินเทอร์เฟซจัดกลุ่มตามโดเมนธุรกิจ พร้อมการอนุญาตตามขอบเขต คำจำกัดฟิลด์และ rate limit ตามเอกสารทางการ
-
อุปกรณ์และจุด
สอบถามสถานะออนไลน์ RCU แผง และเซ็นเซอร์ อ่าน/เขียนค่าจุด I/O ดิจิทัลและแอนะล็อก
-
ห้องและสถานะ
ซิงค์ check-in/out, DND, MUR, SOS และสถานะห้องอื่น ๆ แมปกับหมายเลขห้อง PMS
-
ฉากและลิงก์
ทริกเกอร์ต้อนรับ ปิดไฟเมื่อไม่มีคน โหมดประชุม และฉากอื่น ๆ สอบถามผลและสาเหตุความล้มเหลว
-
พลังงานและรายงาน
รวมข้อมูลไฟฟ้าและ HVAC ตามห้อง ชั้น หรือพื้นที่สาธารณะ ส่งออกอินเทอร์เฟซรายงาน
-
การแจ้งเตือนและ ops
สมัครรับการแจ้งเตือนอุปกรณ์ออฟไลน์ ข้อผิดพลาดการสื่อสาร และโหลด ผสานกับระบบ ticket
-
โครงการและการเข้าถึง
แยกผู้เช่าหลายโรงแรม/โครงการ จัดการ AppKey บทบาท และขอบเขต API
เริ่มต้นอย่างรวดเร็ว
-
ลงทะเบียนบัญชีนักพัฒนา
ส่งคำขอผสานรวมผ่านฝ่ายขายหรือสนับสนุน เพื่อรับ AppKey / AppSecret
-
ตั้งค่า callback URL
ลงทะเบียน URL Webhook ในคอนโซลนักพัฒนาสำหรับเหตุการณ์สถานะห้องและการแจ้งเตือน
-
ผสานรวม sandbox
เรียก API ด้วย ID โครงการทดสอบ เพื่อตรวจสอบลายเซ็น auth และฟิลด์ธุรกิจ
-
Go-live production
หลังรับรอง เปลี่ยนเป็นข้อมูล production และติดตามปริมาณการเรียกและอัตราข้อผิดพลาดตาม SLA
endpoint ทั่วไป
ตัวอย่างเส้นทาง REST ทั่วไป ดาวน์โหลด spec OpenAPI เต็มจากศูนย์ดาวน์โหลด
| วิธี | เส้นทาง | คำอธิบาย |
|---|---|---|
| POST | /v1/oauth/token | รับ access token (Client Credentials) |
| GET | /v1/projects/{id}/rooms | รายการห้องแบบแบ่งหน้าพร้อมสรุปสถานะ |
| GET | /v1/projects/{id}/rooms/{roomNo}/devices | อุปกรณ์และสถานะออนไลน์ของห้อง |
| PUT | /v1/projects/{id}/rooms/{roomNo}/scene/{sceneId} | ทริกเกอร์ฉาก (เช่น ต้อนรับ ปิดไฟเมื่อไม่มีคน) |
| POST | /v1/projects/{id}/rooms/{roomNo}/points | เขียนจุดแบบกลุ่ม (สวิตช์ หรี่แสง setpoint HVAC ฯลฯ) |
| GET | /v1/projects/{id}/energy/summary | สรุปพลังงานตามช่วงเวลา |
| POST | /v1/webhooks/subscriptions | ลงทะเบียนการสมัคร Webhook (สถานะห้อง การแจ้งเตือน ฯลฯ) |
โปรโตคอลและระบบนิเวศ
นอกจาก HTTP API ยังรองรับ field bus และแพลตฟอร์มบุคคลที่สามสำหรับการผสานรวมโรงแรมและอาคารที่หลากหลาย
BACnet / Modbus
แปลงโปรโตคอลสำหรับ BMS, HVAC, มิเตอร์ และ subsystem อื่น ๆ
MQTT
รายงานอุปกรณ์และส่งคำสั่งในสถานการณ์แบนด์วิดท์ต่ำ
KNX / ปลั๊กอินระบบนิเวศ
ใช้ร่วมกับ KNX, Home Assistant และโซลูชันเชื่อมต่ออื่น ๆ
ขั้นตอน onboarding
ส่งคำขอ
อธิบายสถานการณ์ผสานรวม ปริมาณการเรียกที่คาดหวัง และไทม์ไลน์ go-live
ออก credentials
กำหนดคีย์สภาพแวดล้อม sandbox และ production
ทดสอบการผสานรวม
ฝ่ายสนับสนุนทางเทคนิคช่วยทดสอบ API และ Webhook
เปิดใช้งานจริง
เปลี่ยนเป็น production และรวมในการติดตาม ops
คำถามที่พบบ่อย
ขอ API keys อย่างไร?
เปิดให้ integrator ที่ทำสัญญาและลูกค้าเชิงกลยุทธ์ ส่งสรุปการผสานรวมผ่านฝ่ายขายหรือสนับสนุน หลังอนุมัติสร้างแอปในคอนโซลนักพัฒนาเพื่อรับ AppKey และ AppSecret
รองรับการ deploy gateway ท้องถิ่นหรือไม่?
ใช่ กลุ่มโรงแรมขนาดใหญ่ใช้ edge gateway ท้องถิ่นพร้อม API สอดคล้องกับคลาวด์ในสถานการณ์ออฟไลน์และ latency ต่ำ สถาปัตยกรรมกำหนดตามโครงการ
มี rate limit หรือไม่?
QPS เริ่มต้นและโควตารายวันต่อแอป โครงการขนาดใหญ่ขอเพิ่มได้ เกินขีดจำกัดคืน 429 — ใช้ exponential backoff
Webhook ปลอดภัยอย่างไร?
payload เหตุการณ์มีลายเซ็น HMAC และ timestamp ตรวจสอบลายเซ็นและปฏิเสธคำขอเก่า ใช้ endpoint HTTPS รายการ IP ที่อนุญาตตามคำขอ
ต่างจากแพลตฟอร์มคลาวด์อย่างไร?
แพลตฟอร์มคลาวด์เป็น ops แบบ visual สำหรับพนักงาน API นักพัฒนาสำหรับการผสานรวมระบบและ automation — PMS, CRM, แพลตฟอร์มพลังงาน ฯลฯ ใช้ร่วมกันได้
ต้องการฝึกอบรม onsite หรือการสนับสนุนหลังขาย?
เรามีการฝึกอบรมการผสานรวม API การโค้ชการรับรองโครงการ และการสนับสนุนทางเทคนิคตลอดวงจรชีวิต
